NOnovu
Agents

List all agents

Changed on

Retrieve a cursor-paginated list of agents for the current environment. Use after, before, limit, orderBy, and orderDirection query parameters.

get/v1/agents

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Query parameters

afterstring

Cursor for pagination indicating the starting point after which to fetch results.

beforestring

Cursor for pagination indicating the ending point before which to fetch results.

limitnumber
Example:10

Limit the number of items to return

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBystring

Field to order by

includeCursorboolean

Include cursor item in response

identifierstring

Filter agents by partial, case-insensitive match on identifier.

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

nextstring nullable required

The cursor for the next page of results, or null if there are no more pages.

previousstring nullable required

The cursor for the previous page of results, or null if this is the first page.

totalCountnumber required

The total count of items (up to 50,000)

totalCountCappedboolean required

Whether there are more than 50,000 results available

Changes

  • 6349165a6e58Revision changes
    • breaking

      the /// response's property type changed from object to string for status

  • f056922796adRevision changes
    • info

      added the optional property /// to the response with the status