Teams

Get a team by name

Get a team by name.

get/v1/teams/name/{name}

Request

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

Path parameters

namestring required

Name of the team

Query parameters

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

Fields requested in the returned resource

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

Include all, deleted, or non-deleted entities.

Response

The team

idstring uuid required
teamType'Group' | 'Department' | 'Division' | 'BusinessUnit' | 'Organization'
namestring required
emailstring
fullyQualifiedNamestring
displayNamestring
externalIdstring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
childrenCountinteger
userCountinteger
isJoinableboolean
deletedboolean
provider'system' | 'user' | 'automation'
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

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