Skip to main content
GET
/
parties
/
me
/
members
List party members
curl --request GET \
  --url https://api.natural.co/parties/me/members \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "user",
      "id": "usr_019cd1798d657de5b5fed4198cb9fac0",
      "attributes": {
        "partyId": "pty_019cd1798d617f65a79cb965dda9eac3",
        "role": "MEMBER",
        "status": "ACTIVE",
        "type": "member",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-15T10:30:00Z",
        "userName": "Eric Smith",
        "userEmail": "eric@natural.co",
        "invitationId": null,
        "partyType": "ORG",
        "partyDisplayName": "Natural",
        "partyLegalName": "Natural AI, Inc",
        "invitedBy": 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

cursor
string

Cursor for pagination

limit
integer
default:50

Max items per page

Required range: 1 <= x <= 100
includeInvitations
boolean
default:true

Include pending invitations in results

Response

Successful Response

data
UserMemberResource · object[]
required
meta
object
required