Skip to main content
GET
/
api
/
v1
/
agents
List agents
curl --request GET \
  --url https://agents.nanonets.com/api/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_number": 123,
      "name": "<string>",
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Workspace API key issued from the web app. Pass as Authorization: Bearer YOUR_API_KEY.

Query Parameters

​
cursor
string

Opaque pagination cursor returned by a previous response in next_cursor. Omit on the first request.

​
limit
integer
default:20

Maximum number of items to return. Defaults to 20; max 100.

Required range: 1 <= x <= 100
​
q
string

Substring match against agent name (case-insensitive).

​
status
string

Comma-separated list of statuses to include (draft, published, archived). Default returns all non-archived.

Response

Paginated list of agents.

​
data
object[]
required
​
has_more
boolean
required
​
next_cursor
string | null

Cursor to fetch the next page. null when there are no more items.