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 |
|---|---|
associations.readonly | Read association type definitions |
associations.write | Create, update, and delete association definitions |
associations/relation.readonly | Read record-level relations |
associations/relation.write | Create and delete record-level relations |
Quick start
Get all association definitions for a sub-account:Endpoints
| Method | Path | Description |
|---|---|---|
GET | /associations/ | Get all associations for a sub-account / location |
POST | /associations/ | Create Association |
GET | /associations/{associationId} | Get association by ID |
PUT | /associations/{associationId} | Update Association By Id |
DELETE | /associations/{associationId} | Delete Association |
GET | /associations/key/{key_name} | Get association key by key name |
GET | /associations/objectKey/{objectKey} | Get association by object keys |
POST | /associations/relations | Create Relation for your associated entities |
GET | /associations/relations/{recordId} | Get all relations By record Id |
DELETE | /associations/relations/{relationId} | Delete Relation |
Related
- Objects API overview — define custom object schemas that participate in associations
- Custom Fields API overview — add structured fields to the objects you associate
- OAuth 2.0 overview — obtain and refresh access tokens
.png?fit=max&auto=format&n=EQK5eX9kTD8NzWwA&q=85&s=878008bf159fcc4964d0c0d508b6e400)