Team related paths

GET /api/v4/teams

Get the list of teams on the server.

🔍 Try it!

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (array) – List of Team objects.

Status Codes:

• 200 OK – No error.

GET /api/v4/teams/{team_id}

Get team info.

🔍 Try it!

Parameters:

• team_id – ID of the team.

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (object) – The Team object.

Status Codes:

• 200 OK – No error.

PUT /api/v4/teams/{team_id}

Update team settings.

Must have admin rights.

🔍 Try it!

Parameters:

• team_id – ID of the team.

Request JSON Object:

• object – Team object with updated fields.

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (object) – Updated Team object of the team.

Status Codes:

• 200 OK – No error.

DELETE /api/v4/teams/{team_id}

Delete the team.

Must have admin rights.

🔍 Try it!

Parameters:

• team_id – ID of the team.

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (object) – Team object of deleted team.

Status Codes:

• 200 OK – No error.

GET /api/v4/teams/{team_id}/chats

Get the list of chats in the team.

🔍 Try it!

Parameters:

• team_id – ID of the team.

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (array) – List of Chat objects.

Status Codes:

• 200 OK – No error.

GET /api/v4/teams/{team_id}/contacts

Get the list of contacts of the team.

🔍 Try it!

Parameters:

• team_id – ID of the team.

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (array) – List of Contact objects.

Status Codes:

• 200 OK – No error.

GET /api/v4/teams/{team_id}/contacts/{contact_id}

Get contact details.

🔍 Try it!

Parameters:

• team_id – ID of the team.

• contact_id – ID of the contact.

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (object) – The Contact object.

Status Codes:

• 200 OK – No error.

POST /api/v4/teams/{team_id}/contacts/{contact_id}

Update contact details.

🔍 Try it!

Parameters:

• team_id – ID of the team.

• contact_id – ID of the contact.

Request JSON Object:

• object – The Contact object.

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (object) – Updated Contact object.

Status Codes:

• 200 OK – No error.

DELETE /api/v4/teams/{team_id}/contacts/{contact_id}

Remove contact from the team.

Must have admin rights.

🔍 Try it!

Parameters:

• team_id – ID of the team.

• contact_id – ID of the contact.

Response JSON Object:

• ok (boolean) – True if no error occured.

• result (object) – Removed Contact object.

Status Codes:

• 200 OK – No error.