List users

List users for the current tenant with offset pagination. Filter by reference (returns at most one user, since reference is unique), email, or creation date range.

GET /v1/agents/users

List users

cURL

curl --request GET \
  --url https://api.quintus.tec.br/v1/agents/users \
  --header 'X-API-Key: <api-key>'

200

{
  "items": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "reference": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "metadata": {},
      "info": {}
    }
  ],
  "next_offset": 123
}

Autorizações

X-API-Key · string · header · obrigatório

Parâmetros de consulta

reference · string | null

email · string | null

created_after · string<date-time> | null

created_before · string<date-time> | null

limit · integer · padrão: 20

Intervalo obrigatório: 1 <= x <= 100

offset · integer · padrão: 0

Intervalo obrigatório: x >= 0

Resposta

200

application/json

Successful Response

items · UserResponse · object[] · obrigatório

Show child attributes

next_offset · integer | null

Pass as offset to fetch the next page. Null = no more results.