Skip to main content
GET
List party invitations

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Agent-ID
string | null

Agent (agt_*) to attribute this request to when authenticating with a party API key; omit for agent keys and agent-scoped OAuth grants, which already carry agent identity.

Maximum string length: 36
Pattern: ^agt_[0-9a-f]{32}$
X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Query Parameters

partyId
string

Party to filter by; only your own party is accepted.

Pattern: ^pty_[0-9a-f]{32}$
email
string

Filter by email.

Maximum string length: 254
status
enum<string>

Filter by status.

Available options:
PENDING,
ACCEPTED,
REVOKED,
DECLINED

Response

Successful Response

data
InvitationResource · object[]
required
meta
object
required