Skip to main content
GET
Get credit usage for agents in a space
The organization bot token must have the following scopes:
  • workflows:read

Authorizations

Authorization
string
header
required

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

Headers

Notion-Version
enum<string>
required

The Admin API version to use for this request.

Available options:
2026-06-01

Path Parameters

space_id
string<uuid>
required

Query Parameters

cursor
string

Cursor for the outer agent list. Nested result cursors paginate that agent's billing periods through the single-agent credit-usage endpoint instead.

include_deleted
enum<string>

Set to "true" to include soft-deleted agents and their retained credit usage; included deleted agents have status "deleted". Omit this parameter or set it to "false" to return only live agents. Permanently deleted tombstones are never returned.

Available options:
false,
true

Response

has_more
boolean
required

Whether more agents are available.

results
object[]
required

The page of agents with their credit usage, up to 100 agents per request. Every agent starts at its most recent billing period; a nested result's 'next_cursor' paginates that agent's billing periods through the single-agent credit-usage endpoint.

next_cursor
string

Cursor to pass as 'cursor' on the next request to fetch the next page of agents; omitted when 'has_more' is false.