Skip to main content
GET
List subscriptions

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header: Authorization: Bearer <YOUR_API_KEY>.

Query Parameters

page_size
integer
required

Max items per page, 1-100. Omitting it returns 400; a value > 100 returns 400.

Required range: 1 <= x <= 100
page_token
string | null

Cursor from a previous response's next_page_token; omit for the first page.

sort_direction
enum<string>
default:desc

Sort order: asc or desc.

Available options:
asc,
desc
agent_id
string

Only return subscriptions for this agent.

q
string

Case-insensitive search across name, URL and description. Ignored if shorter than 2 characters.

delivery_mode
enum<string>

Filter by delivery mode. ALL (or omitted) applies no filter.

Available options:
PUSH,
PULL,
ALL

Response

OK.

data
WebhookSubscriptionResponse · object[]

Page of subscription objects (no secret).

next_page_token
string | null

Cursor for the next page; null on the last page.

total_count
integer

Total subscriptions matching the query.

Example:

1