Skip to main content
GET
/
party-invitations
List invitations
curl --request GET \
  --url https://api.natural.co/party-invitations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "invitation",
      "id": "inv_019cd4a832f37c4b8a1d63e94b7c8d12",
      "attributes": {
        "email": "engineer@velocitylogistics.com",
        "role": "MEMBER",
        "status": "PENDING",
        "expiresAt": "2026-01-11T15:30:00Z",
        "createdAt": "2026-01-04T15:30:00Z",
        "acceptedAt": null
      }
    }
  ],
  "meta": {
    "pagination": {
      "hasMore": false,
      "nextCursor": null
    }
  }
}

Authorizations

Authorization
string
header
required

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

Headers

X-Agent-ID
string | null

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

X-Instance-ID
string | null

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

Maximum string length: 1024

Query Parameters

partyId
string

Filter by party

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

Filter by email

status
enum<string>

Filter by status

Available options:
PENDING,
ACCEPTED,
REVOKED

Response

Successful Response

data
object[]
required
meta
object
required