Pular para o conteúdo principal
GET
/
agents
Listar assistentes
curl --request GET \
  --url https://api.meuassistente.rdstationmentoria.com.br/rest/agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "workspaceId": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "description": null,
      "avatar": null,
      "color": "#ff5722",
      "welcome": null,
      "instructions": null,
      "off": null,
      "references": false,
      "purpose": "leads",
      "freedom": "restricted",
      "behavior_type": "basic",
      "status": "draft",
      "left": false,
      "createdAt": "2025-11-26T20:01:11.895Z",
      "updatedAt": "2025-11-26T20:01:11.895Z"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "size": 123,
    "first": 123,
    "last": 123,
    "next": 123,
    "previous": 123
  }
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

page
number
padrão:1

Número da página

Intervalo obrigatório: x >= 1
size
number
padrão:20

Tamanho da página

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

Texto livre para busca pelo nome do assistente

Resposta

Successful response

Página de registros

data
object[]
obrigatório

Lista de registros da página

meta
object
obrigatório

Metadados da página