GET Object Schema by key / id

GEThttps://services.leadconnectorhq.com/objects/{key}
Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0
Request

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

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Request

Security: Bearer Auth

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

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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

fetchProperties
string

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

Example:
true
locationId
string
required

location id of the sub account

Example:
632c34b4c9b7da3358ac9891

Headers

Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

object
object
id
string
required

id of the custom / standard object schema

Example:
661c06b4ffde146bdb469442
standard
boolean
required

false in case of custom objects and true in case of standard objects like contacts and opportunities

Example:
false
key
string
required

key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by default

Example:
custom_objects.pet
labels
object
required

This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI

Example:
{"singular":"Pet","plural":"Pets"}
description
string

Custom / Standard Object Descriptions for example , Pet Object`s description

Example:
These are non vaccinated pets
locationId
string
required

location's id

Example:
Q9DT3OAqEXDLYuob1G32
primaryDisplayProperty
string
required

Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for company)' would be added as prefix by default for all the custom / standard objects

Example:
custom_objects.pet.name
dateAdded
string<date-time>
required

Date and time when the object was added

dateUpdated
string<date-time>
required

Date and time when the object was last updated

type
object

Object`s Type

Example:
The Object type can either USER_DEFINED or SYSTEM_DEFINED
cache
boolean
required

Is the response served from cache

Example:
true
fields
array[object]
locationId
string
required

Location Id

Example:
ve9EPM428h8vShlRW1KT
name
string

Field name

Example:
Name
description
string

Description of the field

placeholder
string

Placeholder text for the field

showInForms
boolean
required

Whether the field should be shown in forms

options
array[object]

Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)

acceptedFormats
string

Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all

Allowed values:
.pdf.docx.doc.jpg.jpeg.png.gif.csv.xlsx.xlsall
id
string
required

Unique identifier of the object

objectKey
string
required

The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

Example:
custom_object.pet
dataType
string
required

Type of field that you are trying to create

Allowed values:
TEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSDATETEXTBOX_LISTFILE_UPLOADRADIO
parentId
string
required

ID of the parent folder

Example:
3v34PM428h8vShlRW1KT
fieldKey
string
required

Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldName}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.

Example:
custom_object.pet.name
allowCustomOption
boolean

Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.

Example:
true
maxFileLimit
number

Maximum file limit for uploads

Example:
2
dateAdded
string<date-time>
required

Date and time when the object was added

dateUpdated
string<date-time>
required

Date and time when the object was last updated

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity