Upbooks API

GetOrganizationDashboardView

GET

https://api.upbooks.io/api/v1/organization/dashboard/view

Organization

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

000000

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.upbooks.io/api/v1/organization/dashboard/view' \
--header 'ORGANIZATION-ID: 000000'

Responses

🟢200Ok

application/json

Body

data

object (IOrganizationDashboardViewRes)

required

hasAtleastOneProduct

boolean

required

hasAtleastOneService

boolean

required

hasAtleastOneOrder

boolean

required

hasAtleastOneInvoice

boolean

required

hasAtleastOneEmployee

boolean

required

hasOrganizationTaxConfigured

boolean

required

hasOnlinePaymentsConfigured

boolean

required

message

string

optional

Example

{
    "data": {
        "hasAtleastOneProduct": true,
        "hasAtleastOneService": true,
        "hasAtleastOneOrder": true,
        "hasAtleastOneInvoice": true,
        "hasAtleastOneEmployee": true,
        "hasOrganizationTaxConfigured": true,
        "hasOnlinePaymentsConfigured": true
    },
    "message": "string"
}

🟢200Success

GetOrganizationSubscriptions

GetOrganizationDashboardSnapshot