v2

latestOpenAPI 3.1.02026-07-26391214472.7 KB
record-team

Search Team Candidates

Search for users eligible to be team members.

Returns users whose role is in the same record type group as the record. Excludes the record owner and users already on the team. Requires read access to the record.

get/api/v1/objects/{object_type}/records/{record_id}/team/candidates

Path parameters

object_typestring required
record_idinteger required

Query parameters

searchstring nullable

Headers

authorizationstring nullable
X-API-Keystring nullable

Response

Successful Response

totalinteger required