GetWidgets - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

slots

string

optional

section

string

optional

uid

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

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/widget?slots&section&uid' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok

application/json

Body

data

array[object (IDashboardWidget) {11}]

required

uid

string

required

name

string

required

section

enum<string>

required

Allowed values:

salesfinancepurchasehroperationspre-sales

thumbnail

string | null

optional

apiUrl

string | null

optional

apiFilter

null

optional

slots

array[number <double>] | null

optional

styles

null

optional

filters

array[string] | null

optional

content

null

optional

requiredFilters

array[string] | null

optional

totalCount

number <double>

optional

filteredCount

number <double>

optional

message

string

optional

Example

{
    "data": [
        {
            "uid": "string",
            "name": "string",
            "section": "sales",
            "thumbnail": "string",
            "apiUrl": "string",
            "apiFilter": null,
            "slots": [
                0
            ],
            "styles": null,
            "filters": [
                "string"
            ],
            "content": null,
            "requiredFilters": [
                "string"
            ]
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success