Skip to main content
POST
Search Object Records

Authorizations

Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Path Parameters

schemaKey
string
required

custom object key

Example:

"632c34b4c9b7da3358ac9891"

Body

application/json
locationId
string
required

Location Id

Example:

"ve9EPM428h8vShlRW1KT"

page
number
required

Page

Example:

1

pageLimit
number
required

Page Limit

Example:

10

query
string
required

Pass this query parameter to search using your searchable properties. For example, if you have a custom object called “Pets” and have configured “name” as a searchable property, you can pass name:Buddy to search for pets with the name “Buddy.”

Example:

"Buddy"

searchAfter
string[]
required
Example:

Response

Successful response

total
number
required

Total Number of records

Example:

20

records
object[]

Records

Last modified on March 8, 2026