Skip to content
Teams/
List teams

List teams

Request

Return the teams that cases can be assigned to, for use in case.teams when creating a case. Filters are combined with AND; unknown query parameters are rejected.

Security
oauth2ClientCredentials(Required scopes: teams:read) and apiKeyAuth
Query
namestring, [ 1 .. 254 ] characters

Only teams whose name contains this text (case-insensitive).

Example:name=Claims
usernamestring, [ 1 .. 254 ] characters

Only teams with an active member that has this username (case-insensitive exact match).

Example:username=jane.doe
emailstring, [ 1 .. 254 ] characters

Only teams with an active member that has this email (case-insensitive exact match).

Example:email=jane.doe@example.com
limitinteger, [ 1 .. 100 ]

Page size.

Default:10
Example:limit=10
offsetinteger, >= 0

Number of teams to skip.

Default:0
Example:offset=0
curl -i -X GET \
  'https://docs.wisedocs.ai/_mock/api/openapi/api/v1/teams?name=Claims&username=jane.doe&email=jane.doe%40example.com&limit=10&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Matching teams.

Bodyapplication/json
statusstringrequired
Value:"success"
Example:"success"
dataobject(TeamList)required
Response
{
  "status": "success",
  "data": {
    "count": 1,
    "results": [ … ]
  }
}