Get - 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

country

string

optional

type

string

optional

status

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

name

sortOrder

number <double>

optional

Default:

1

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/lead?searchText&country&type&status' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok

application/json

Body

data

array[object (LeadDocumentJSON) {16}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

leadType

enum<string>

required

Allowed values:

businessindividual

name

string

required

status

enum<string>

required

Allowed values:

newcontactedqualifiedunqualifiedconvertedlostjunk

source

string | null

optional

expectedValue

object

optional

primaryContactId

string | null

optional

notes

string | null

optional

contacts

array[object (IContact) {9}] | null

optional

billingAddress

optional

shippingAddress

optional

leadNumber

string

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",
            "organizationId": "string",
            "leadType": "business",
            "name": "string",
            "status": "new",
            "source": "string",
            "expectedValue": {
                "currency": {
                    "name": "string",
                    "symbol": "string"
                },
                "amount": 0
            },
            "primaryContactId": "string",
            "notes": "string",
            "contacts": [
                {
                    "isPrimary": true,
                    "salutation": "Mr.",
                    "firstName": "string",
                    "lastName": "string",
                    "email": "string",
                    "workPhone": "string",
                    "mobilePhone": "string",
                    "designation": "string",
                    "department": "string"
                }
            ],
            "billingAddress": {
                "locationName": "string",
                "street1": "string",
                "street2": "string",
                "pincode": "string",
                "city": "string",
                "state": "string",
                "country": "string"
            },
            "shippingAddress": {
                "locationName": "string",
                "street1": "string",
                "street2": "string",
                "pincode": "string",
                "city": "string",
                "state": "string",
                "country": "string"
            },
            "leadNumber": "string"
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success