Teams

List teams

Get a list of teams. Use fields parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using limit and before or after query params.

get/v1/teams

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/teams
  • Auth: HTTP bearer

Query parameters

fieldsstring
Example:owners,profile,users,owns,defaultRoles,defaultPersona,parents,children,policies,userCount,childrenCount,descendantTeams,domains

Fields requested in the returned resource

limitinteger

Limit the number of teams returned. (1 to 1000000, default = 10)

beforestring

Returns list of teams before this cursor

afterstring

Returns list of teams after this cursor

parentTeamstring

Filter the results by parent team name

isJoinableboolean

Filter the results by whether the team can be joined by any user or not

ownsEntityTypestring
Example:pipeline

When fields contains owns, only include owned entities of this entity type.

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

Response

List of teams

warningsCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.