latestOpenAPI 3.1.12026-08-239938.6 MB

b1ad79e918ac

Invitations

List party invitations

get/party-invitations

Query parameters

partyIdstring

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

emailstring

Filter by email.

status'PENDING' | 'ACCEPTED' | 'REVOKED' | 'DECLINED'

Filter by status.

Headers

X-Agent-IDstring nullable

Deprecated: agent identity comes from the credential. Sending this header with a party API key or user credential returns 403 agent_credential_required.

X-Instance-IDstring nullable

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

Response

Successful Response