GetOrganizations - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

searchText

string

optional

plan

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

createdAt

sortOrder

number <double>

optional

Default:

1

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/organization?searchText&plan' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 000000'

Responses

🟢200Ok

application/json

Body

data

array[object (OrganizationDocumentJSON) {21}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

name

string

required

organizationId

string

required

location

string

required

state

string

required

logo

string | null

optional

regionalSetting

object (IRegionalSetting)

required

taxSettings

array[object (IOrgTaxSettings) {3}] | null

optional

userId

string

required

settings

object (IOrganizationSettings)

required

fromEmail

string

optional

fiscalYear

object

optional

businessSettings

object | null

optional

isDeactivated

boolean

optional

platformCredits

object (IOrganizationPlatformCredits)

optional

registrationSource

enum<string>

optional

Allowed values:

upbooks-webupbooks-android-appupbooks-ios-appupbooks-expense-webupbooks-expense-android-appupbooks-expense-ios-app

organizationType

enum<string>

optional

Allowed values:

individualbusiness

phone

object (IPhone)

optional

message

string

optional

Example

🟢200Success