GetAllDocumentsOfOrganiztion

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

searchText

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

000000

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.upbooks.io/api/v1/document?searchText' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'ORGANIZATION-ID: 000000'

Responses

🟢200Ok

application/json

Body

data

array[object (IDocumentDocumentJSON) {14}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organization

object (ICommonOrganization)

required

folder

string | null

optional

fileName

string

required

url

string

required

thumbnail

string | null

optional

name

string

required

size

number <double>

required

type

enum<string>

required

Allowed values:

invoicepurchase-orderproposalexpenseproductserviceordersalary-slipprojectstasksothersassetpaymentoutward-paymentcredit-notedebit-noteemployeeleads

extension

string | null

optional

moduleInternalId

string | null

optional

totalCount

number <double>

optional

filteredCount

number <double>

optional

message

string

optional

Example

{
    "data": [
        {
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "__v": 0,
            "_id": "string",
            "organization": {
                "id": "string",
                "organizationId": "string",
                "name": "string",
                "state": "string"
            },
            "folder": "string",
            "fileName": "string",
            "url": "string",
            "thumbnail": "string",
            "name": "string",
            "size": 0,
            "type": "invoice",
            "extension": "string",
            "moduleInternalId": "string"
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success