v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

ProfilePerson

List person for a profile

Get all person where this profile is linked to persons/guests

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

Path parameters

profileIdinteger required

Entity ID

Query parameters

personType'CONTACT' | 'GUEST'

Type of persons

Filter by relationship type

rolesContactRole[]

Filter by profile person roles. Returns persons matching any of the specified roles. Use comma-separated values for multiple roles.

[
  "BOOKING_COORDINATOR"
]

sortstring

Sort profile persons by field and direction in format: field:direction Multiple fields can be separated by semicolon. Examples: role:asc, createdAt:desc, role:asc;createdAt:desc Valid fields: role, createdAt, updatedAt Valid directions: asc, desc (default: asc) Default sort: createdAt:desc

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 retrieved 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"
    }
  ]
}