Skip to main content

Datastores (Base Entity)

Entity›Datastore

Datastores are lookup tables that hold reference values used throughout TribeCRM — phases, countries, genders, payment methods, units, VAT groups, and many more. They provide the dropdown options and configuration values that other entities reference.

The Datastore endpoint provides a unified view across all datastore types. Use the subtype-specific endpoints (e.g., Datastore_Country, Datastore_Phase_ActivityInvoice) when you need to work with a single type.

Base Entity

Datastore is a base entity. Most datastore subtypes are read-only and managed through the Tribe CRM UI. See Subtypes for the full list.

Endpoints​

List Datastores​

Retrieve a paginated list of all datastore values across all types.

GET/v1/odata/Datastore

Single Datastore​

GET/v1/odata/Datastore({id})

Subtypes​

Datastore is the abstract parent type. All subtypes:

SubtypeOData Entity SetDescription
Address TypesDatastore_AdressTypeAddress type classification
AggregatesDatastore_AggregateAggregation methods
AlignmentsDatastore_AlignmentLayout alignment options
Appointment TypesDatastore_AppointmentTypeAppointment categories
BranchesDatastore_BranchIndustry branches
Calendar Attendee StatusesDatastore_CalendarItemAttendeeResponseStatusCalendar response statuses
Campaign TypesDatastore_CampagneCampaign categories
ChannelsDatastore_ChannelCommunication channels
Contact RolesDatastore_RoleContact role definitions
CountriesDatastore_CountryCountries
Data Category LayoutsDatastore_DataCategory_LayoutDataset category layouts
Education LevelsDatastore_EducationEducation levels
Email Address TypesDatastore_EmailAddressTypeEmail address types
Emailing CategoriesDatastore_EmailingCategoryEmail subscription categories
Event LocationsDatastore_EventLocationEvent venues
Event Participation StatusesDatastore_EventParticipationStatusEvent attendance statuses
Event TypesDatastore_EventTypeEvent categories
FunctionsDatastore_FunctionJob functions
GendersDatastore_GenderGender options
General Ledger AccountsDatastore_GeneralLedgerAccountAccounting ledger accounts
GroupsDatastore_GroupRelationship groups
Identification TypesDatastore_KindOffIdentificationIdentity document types
IndustriesDatastore_IndustryLead industry sectors
Involved RolesDatastore_InvolvedRoleActivity participant roles
LanguagesDatastore_LanguageLanguages
Legal FormsDatastore_LegalFormLegal forms (BV, NV, etc.)
License Contract EditionsDatastore_LicenseContractEditionLicense editions
Lost ReasonsDatastore_LostReasonOpportunity lost reasons
Payment MethodsDatastore_PaymentMethodPayment methods
Payment StatusesDatastore_PaymentStatusPayment statuses
Phone Number TypesDatastore_PhoneNumberTypePhone number types
PrioritiesDatastore_PriorityPriority levels
Product Issue CausesDatastore_ProductIssue_CauseProduct issue causes
Project RolesDatastore_ProjectRoleProject roles
Reasons LostDatastore_ReasonLostAdditional lost reasons
Sales CategoriesDatastore_SalesCategorySales categories
Sentiment CategoriesDatastore_SentimentCategorySentiment classifications
Sentiment TopicsDatastore_SentimentTopicSentiment analysis topics
SkillsDatastore_SkillEmployee skills
SourcesDatastore_SourceLead/opportunity sources
StatesDatastore_StateStates/provinces
StatusesDatastore_StatusRelationship statuses
Task TypesDatastore_TaskTypeTask categories
Trend IndicationsDatastore_TrendIndicationTrend directions
UnitsDatastore_UnitUnits of measure
UrgenciesDatastore_UrgencyUrgency levels
VAT GroupsDatastore_VatGroupVAT groups

Phase Subtypes​

Phases are a special category of datastores that define workflow stages for each activity type. See the dedicated Phases page for full documentation, fields, and usage examples.

Fields​

Datastore Fields​

FieldTypeDescription
NameStringDisplay name
CodeStringUnique code identifier
LocalizedNameStringLocalized display name
IsDefaultBooleanWhether this is the default value

Filtering Examples​

warning

Filtering by _Type is not supported To narrow by datastore subtype, query that subtype's own entity set instead (e.g. /v1/odata/Datastore_Country, /v1/odata/Datastore_Phase). See Filtering by Type.

GET/v1/odata/Datastore?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore?$filter=Code eq '{Code}'&$top={top}
GET/v1/odata/Datastore?$filter=IsDefault eq {IsDefault}&$top={top}
GET/v1/odata/Datastore?$filter=contains(Name, '{Name}')&$top={top}

Custom Query​

Build your own OData query against Datastore. 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/Datastore?$top=10