Skip to navigation
API ReferenceInvitations

List invitations

List invitations with optional filters by party, email, or status.

Authentication

AuthorizationBearer

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

Headers

X-Agent-IDstring or nullOptional

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-IDstring or nullOptional<=1024 characters

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Query parameters

partyIdstringOptionalformat: "^pty_[0-9a-f]{32}$"
emailstringOptional
statusenumOptional
Filter by status
Allowed values:

Response headers

X-RateLimit-Limitinteger
Maximum requests allowed per window
X-RateLimit-Remaininginteger
Requests remaining in current window
X-RateLimit-Resetinteger
Unix timestamp when rate limit resets

Response

Successful Response
datalist of objects
metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
428
Precondition Error
429
Too Many Requests Error
500
Internal Server Error
501
Not Implemented Error
502
Bad Gateway Error
503
Service Unavailable Error