Skip to main content
GET
Get Object Schema by key / id

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

key
string
required

key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI.

Example:

"custom_objects.pet"

Query Parameters

locationId
string
required

location id of the sub account

Example:

"632c34b4c9b7da3358ac9891"

fetchProperties
string

Fetch Properties , Fetches all the standard / custom fields of the object when set to true

Example:

true

Response

Successful response

cache
boolean
required

Is the response served from cache

Example:

true

object
object
fields
object[]
Last modified on March 8, 2026