get https://{youraccountname}.api-us1.com/api/3/customObjects/schemas
Retrieve all schemas available within an account.
Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.
{
"schemas": [
{
"id": "6449c3f3-b68d-46d1-850b-c8aea998ce1b",
"slug": "my-object",
"visibility": "private",
"labels": {
"singular": "My Object",
"plural": "My Objects"
},
"description": "Sample Schema",
"createdTimestamp": "2021-04-16T15:08:25.783751329Z",
"updatedTimestamp": "2021-04-16T15:08:25.783751329Z",
"fields": [
{
"id": "my-number-field",
"labels": {
"singular": "Number",
"plural": "Numbers"
},
"type": "number",
"required": false,
"scale": 0
}
],
"icons": {
"default": "https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png"
},
"relationships": [
{
"id": "primary-contact",
"labels": {
"singular": "Primary Contact",
"plural": "Primary Contacts"
},
"description": "Primary contact to this object",
"namespace": "contacts",
"hasMany": false
}
]
}
],
"meta": {
"total": 1,
"count": 1,
"limit": 20,
"offset": 0
}
}
Filtering schemas
Filtering by contact relationships:
filters[relationships.id][eq]=primary-contact&filters[relationships.namespace][eq]=contacts
Filtering by account relationships:
filters[relationships.id][eq]=account&filters[relationships.namespace][eq]=accounts
Filtering by deal relationships:
filters[relationships.id][eq]=deal&filters[relationships.namespace][eq]=deals
Click here for more information on paging, ordering, sorting, and filtering.
Responses