GET
/
agents
curl --request GET \
  --url https://api.meuassistente.rdstationmentoria.com.br/rest/agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": null,
      "avatar": null,
      "color": "#ff5722",
      "welcome": null,
      "instructions": null,
      "off": null,
      "references": false,
      "purpose": "leads",
      "freedom": "restricted",
      "behavior_type": "basic",
      "status": "draft",
      "fields": [
        "name",
        "email"
      ],
      "left": false,
      "forceLeadIdentification": false,
      "workspaceId": "<string>",
      "createdAt": "2025-07-04T18:19:22.442Z",
      "updatedAt": "2025-07-04T18:19:22.442Z",
      "createdBy": "<string>",
      "updatedBy": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "size": 123,
    "first": 123,
    "last": 123,
    "next": 123,
    "previous": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
number
default:1
Required range: x >= 1
size
number
default:20
Required range: 1 <= x <= 100

Response

200
application/json

Successful response

The response is of type object.

GET
/
agents
curl --request GET \
  --url https://api.meuassistente.rdstationmentoria.com.br/rest/agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": null,
      "avatar": null,
      "color": "#ff5722",
      "welcome": null,
      "instructions": null,
      "off": null,
      "references": false,
      "purpose": "leads",
      "freedom": "restricted",
      "behavior_type": "basic",
      "status": "draft",
      "fields": [
        "name",
        "email"
      ],
      "left": false,
      "forceLeadIdentification": false,
      "workspaceId": "<string>",
      "createdAt": "2025-07-04T18:19:22.442Z",
      "updatedAt": "2025-07-04T18:19:22.442Z",
      "createdBy": "<string>",
      "updatedBy": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "size": 123,
    "first": 123,
    "last": 123,
    "next": 123,
    "previous": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
number
default:1
Required range: x >= 1
size
number
default:20
Required range: 1 <= x <= 100

Response

200
application/json

Successful response

The response is of type object.