Skip to main content
GET
List payment intents

Authorizations

Authorization
string
header
required

An identity bearer token for a person or your backend. Capabilities are per member, per workspace. This credential can manage the workspace and can never authorize an action as an agent.

Path Parameters

workspace_slug
string
required

Query Parameters

agent_id
string<uuid>
budget_id
string<uuid>
state
enum<string>
Available options:
pending,
requires_approval,
executed,
failed,
denied
agent_mode
enum<string>

Narrow to intents whose agent runs in this mode. Any other value is a 400, rather than a silent full listing.

Available options:
live,
test
sort
enum<string>
default:age

Order the whole matching set, not just the page. amount sorts by the intent's value, age by when it was created. An unrecognised value falls back to age.

Available options:
amount,
age
direction
enum<string>
default:desc

Direction for sort. An unrecognised value falls back to desc.

Available options:
asc,
desc
min_amount_cents
integer

Drop anything worth less than this. Applies to the summary as well as the page.

Required range: x >= 0
held_before
string<date-time>

Keep only what was created before this instant, for finding what has been waiting longest. A value that is not ISO 8601 is ignored rather than rejected.

limit
integer
default:50

Page size. Defaults to 50, clamped to 1..200.

Required range: 1 <= x <= 200
starting_after
string<uuid>

The id of the last record on the previous page. An unknown or foreign id is ignored and returns the first page.

Response

A page of payment intents, with a summary of the whole matching set.

data
object[]
required
has_more
boolean
required

True when the page filled to the limit. A final page that exactly fills the limit still reports true; the next request returns an empty page.

next_cursor
string | null
required

Pass back as starting_after.

summary
object

Describes everything the filters matched, not the page that was returned, so a caller can show a true queue size without walking every page.