Skip to main content
GET
/
agent
/
teams
Get Teams
curl --request GET \
  --url https://chat.zoko.io/v2/agent/teams \
  --header 'apikey: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "active": true,
    "memberCount": 123
  }
]

Authorizations

​
apikey
string
header
required

Authentication is done via apikey provided for your account

Include the following in your request header

apikey: "your_apikey_here"

Query Parameters

​
includeAgents
boolean

should the response include agents of the team

Response

Teams List

​
id
string<uuid>

team id

​
name
string

team name

​
description
string

team description

​
active
boolean

is the agent active?

​
memberCount
integer

number of agents in the team