v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

ContactPerson

Search contact persons of organization

get/group-profile/v1/contact-persons

Query parameters

idsinteger[]

Filter contact persons by a list of IDs. Returns only contacts matching these IDs. Use comma-separated values for multiple IDs.

profileIdinteger

Filter contact persons by profile ID (shows only contacts linked to this profile via profile_persons)

firstNamestring

Search term to filter contact persons by firstName (case-insensitive contains)

lastNamestring

Search term to filter contact persons by lastName (case-insensitive contains)

emailstring

Search term to filter contact persons by email (case-insensitive contains)

sortstring

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

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

Contact persons 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": [
    {
      "role": "BOOKING_COORDINATOR",
      "relationshipType": "PRIMARY",
      "prefix": "Mr.",
      "firstName": "John",
      "lastName": "Doe",
      "emails": [
        {
          "emailType": "work",
          "email": "john.doe@example.com"
        }
      ],
      "phones": [
        {
          "phoneType": "mobile",
          "phone": "+1-555-123-4567"
        }
      ],
      "status": "ACTIVE",
      "billingDetails": {
        "address1": "3033 5th Ave.",
        "address2": "Ste 100",
        "city": "San Diego",
        "country": "US",
        "document_number": "142-test",
        "name": "Denise Foreman",
        "postal_code": "60601",
        "phone": "1234567890",
        "state": "IL"
      }
    }
  ]
}