External IDs
External IDs link TribeCRM entities to records in external systems (e.g., accounting software, marketing tools). They are used by connectors for synchronisation.
Endpoints
List
GET
/v1/odata/ExternalIdGet by ID
GET
/v1/odata/ExternalId({id})Create
POST
/v1/odata/ExternalIdUpdate
PUT
/v1/odata/ExternalId({id})Delete
DELETE
/v1/odata/ExternalId({id})Fields
| Field | Type | Description |
|---|---|---|
Service | String | External service name |
Type | String | External entity type |
Id | String | External record identifier |
Metadata | String | Additional metadata (JSON) |
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| ConnectorActivation | ConnectorActivation | N:1 | Connector activation that created this link |
Expanding Relationships
GET
/v1/odata/ExternalId({id})?$expand=ConnectorActivationNavigating Relationships
GET
/v1/odata/ExternalId({id})/ConnectorActivationCustom Query
Build your own OData query against ExternalId. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.
GET
/v1/odata/ExternalId?$top=10