Custom Entities

Tribe CRM allows administrators to define entirely new entity types beyond the built-in ones (Relations, Activities, Relationships, etc.). These are called custom entities.

Discover Your Custom Entities

Log in and fetch the OData $metadata from your Tribe CRM instance to list all custom entity types.

Results

Login and fetch to explore your custom entities.

What Are Custom Entities?

Standard entity types use human-readable names like Activity_Invoice or Relation_Person. Custom entities are assigned a UUID-based identifier by the application, for example: a8bc4eb7-1f80-4287-826f-f240f341a2e7.

Custom entities follow the same inheritance model as built-in types — they extend Entity, Relation, Activity, or another base type, and support the full OData API (list, get, create, update, delete).

Custom fields on existing entities also use the UUID naming convention — they appear in the metadata and API as _117ecf60__d492__48a1__8aab__a131ad465fd5. Use $select to include them in your queries:

GET /v1/odata/Relation_Person?$select=FirstName,LastName,_117ecf60__d492__48a1__8aab__a131ad465fd5

Alternative: find custom entity IDs in the CRM app

In Tribe CRM, go to Configuration → Custom Entities, select an entity, and open the General tab. The "Typenaam in API" field shows the OData EntitySet name you use in API calls. You can also browse all entity types under Configuration → API → Explore Data Model.

Metadata Endpoint

The full schema — including all custom entities and fields — is always available at:

GET/v1/odata/$metadata

The response is an XML document (OData CSDL format). Custom entity types are identified by their UUID-based names. Use this to programmatically discover your instance's schema.