Teams

Manage teams in Exsited: list, create, retrieve, update, enable, disable and delete them.

Teams group people in your Exsited settings. You can list, create, retrieve, update and delete teams, and enable or disable one through its status. This area has 5 endpoints, each available in all seven SDKs.

A team with members cannot be deleted, and a delete cannot be undone. Remove the members first; after a delete, reading the team returns 404.

At a glance

Endpoint	Method	Path	What it does
List teams	GET	/settings/teams	Lists the teams set up in Exsited, one page at a time.
Create a team	POST	/settings/teams	Creates a team and returns it under team.
Retrieve a team	GET	/settings/teams/{team_id}	Retrieves one team by its id.
Delete a team	DELETE	/settings/teams/{team_id}	Deletes a team that has no members; the response has no body.
Update a team	PATCH	/settings/teams/{team_id}	Updates a team’s details, or enables or disables it.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Request bodies go under team. Both the create and the update wrap their fields in a team object, and every single-team response returns it under team.
• Team ids start with team_. Pass that id as team_id.
• version is null on teams. Do not rely on it for change detection.
• status takes active or inactive. Send it in an update to enable or disable a team.
• display_name defaults to name. A team created with only a name gets the same value as its display_name.