List Teams

GET/v1/teams

Returns teams in the workspace that have at least one agent for the given service, ordered by created_at descending. Provide the service UUID via either the service_id query parameter or the x-service-id header (exactly one of the two is required). Empty results return 200 with data: [] and meta.total: 0.

Query Parameters

service_idstring

Service UUID. Filters teams that have agents for this service. Required when x-service-id is not sent.

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

pageinteger

Example:1

per_pageinteger

Example:25

qstring

Optional case-insensitive match against team name.

Example:text

Header Parameters

x-service-idstring

Service UUID header alternative to the service_id query parameter. Required when service_id is not sent.

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataarray[object] required

idstring (uuid)•Team UUID required

namestring required

descriptionstring or null

workspace_idstring (uuid) required

created_atstring

updated_atstring

metaobject (GeneralPaginationMeta) required

current_pageinteger required

per_pageinteger required

totalinteger required

last_pageinteger required

linksobject required

firststring required

laststring required

prevstring or null required

nextstring or null required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-stg.bevatelcloud.com/v1/teams?service_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&page=1&per_page=25&q=text" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "string",
      "description": "string",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "meta": {
    "current_page": 0,
    "per_page": 0,
    "total": 0,
    "last_page": 0,
    "links": {
      "first": "string",
      "last": "string",
      "prev": "string",
      "next": "string"
    }
  }
}