v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

ProfilePerson

Find by person ID

Get all profile where person is the target (reverse lookup)

get/group-profile/v1/profiles/persons/{personId}

Path parameters

personIdinteger required

Person/Guest ID

Query parameters

personType'CONTACT' | 'GUEST' required

Type of persons

Type of person (CONTACT or GUEST) - required to uniquely identify the person

pageTokenstring

Cursor token for pagination. Use the nextPageToken from the previous response to fetch the next page.

Usage:

Omit or pass empty string for the first page
Pass the nextPageToken from previous response for subsequent pages
When nextPageToken is null in the response, you've reached the last page

Benefits over offset-based pagination:

Consistent results even when data changes between requests
Better performance for large datasets (no row skipping)
No maximum page limit

limitinteger

Page size. Specifies the maximum number of items to return in a single response.

Limits:

Minimum: 1
Maximum: 500
Default: 100

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Response

Person found successfully

nextPageTokenstring nullable

Token to fetch the next page of results. Pass this value as the pageToken query parameter in the next request. When null, there are no more pages available.

Example response

{
  "data": [
    {
      "relationshipType": "PRIMARY",
      "role": "BOOKING_COORDINATOR"
    }
  ]
}