Base URL
Authentication
Every request must include a bearer token in theAuthorization header and the API version in the Version header.
OAuth scopes
| Scope | Access |
|---|---|
objects/schema.readonly | Read object schema definitions |
objects/schema.write | Create and update object schemas |
objects/record.readonly | Read and search object records |
objects/record.write | Create, update, and delete object records |
Quick start
List all object schemas available in a sub-account:Endpoints
| Method | Path | Description |
|---|---|---|
GET | /objects/ | Get all objects for a location |
POST | /objects/ | Create Custom Object |
GET | /objects/{key} | Get Object Schema by key / id |
PUT | /objects/{key} | Update Object Schema By Key / Id |
POST | /objects/{schemaKey}/records | Create Record |
GET | /objects/{schemaKey}/records/{id} | Get Record By Id |
PUT | /objects/{schemaKey}/records/{id} | Update Record |
DELETE | /objects/{schemaKey}/records/{id} | Delete Record |
POST | /objects/{schemaKey}/records/search | Search Object Records |
Related
- Custom Fields API overview — add custom field definitions to your object schemas
- Associations API overview — define and query relationships between object records
- OAuth 2.0 overview — obtain and refresh access tokens
.png?fit=max&auto=format&n=EQK5eX9kTD8NzWwA&q=85&s=878008bf159fcc4964d0c0d508b6e400)