Sign in
teams

Get teams

For regular users only returns open teams. Users with the "manage_system" permission will return teams regardless of type. The result is based on query string parameters - page and per_page.

Permissions

Must be authenticated.

get/api/v4/teams

Query parameters

pageinteger

The page to select.

per_pageinteger

The number of teams per page.

include_total_countboolean

Appends a total count of returned teams inside the response object - ex: { "teams": [], "total_count" : 0 }.

exclude_policy_constrainedboolean

If set to true, teams which are part of a data retention policy will be excluded. The sysconsole_read_compliance permission is required to use this parameter.

Response

Team list retrieval successful

idstring
create_atinteger

The time in milliseconds a team was created

update_atinteger

The time in milliseconds a team was last updated

delete_atinteger

The time in milliseconds a team was deleted

display_namestring
namestring
descriptionstring
emailstring
typestring
allowed_domainsstring
invite_idstring
allow_open_inviteboolean
policy_idstring

The data retention policy to which this team has been assigned. If no such policy exists, or the caller does not have the sysconsole_read_compliance_data_retention permission, this field will be null.

Changes