Skip to main content

Teams

EntityTeam

Teams represent groups of employees that can be assigned to entities for access control and organisation. Teams can restrict data access so members only see entities assigned to their team.

Use the Team endpoint to query teams.

Read-only

Teams are managed through the Tribe CRM UI. The API provides read-only access to query existing teams.

Endpoints

List Teams

GET/v1/odata/Team

Single Team

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

Fields

Team Fields

FieldTypeDescription
NameStringTeam name
LocalizedNameStringLocalized team name
IsAccessLimitedToTeamBooleanWhether members can only access team-assigned entities
HasAccessToNonTeamRelationshipsBooleanWhether members can access relationships not assigned to any team

Relationships

RelationshipTarget EntityCardinalityDescription
MembersRelationship.Person.Contact.Employee1:NTeam members (employees)
EntitiesEntity1:NEntities assigned to this team
DatasetsDataset1:NDatasets
ViewsView1:NViews
KpiTargetsKpiTarget1:NKPI targets
KpiMeasurementsKpiMeasurement1:NKPI measurements

Expanding Relationships

GET/v1/odata/Team({id})?$expand=Members
GET/v1/odata/Team({id})/Members

Filtering Examples

GET/v1/odata/Team?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Team?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Team?$filter=IsAccessLimitedToTeam eq {IsAccessLimitedToTeam}&$top={top}