---
updatedAt: 2026-04-24T16:40:21.000Z
agentTools:
  projectIndex: https://developers.cloudbeds.com/llms.txt
---

# Search contact persons of organization

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Group Profile API",
    "version": "1.0.0",
    "description": "API for managing group profiles, contact persons, and related operations"
  },
  "tags": [
    {
      "name": "ContactPerson",
      "description": "Contact Person API"
    }
  ],
  "servers": [
    {
      "url": "https://api.cloudbeds.com"
    }
  ],
  "paths": {
    "/group-profile/v1/contact-persons": {
      "get": {
        "summary": "Search contact persons of organization",
        "operationId": "SearchContactPersons",
        "tags": [
          "ContactPerson"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/xPropertyId"
          },
          {
            "$ref": "#/components/parameters/xOrganizationId"
          },
          {
            "name": "ids",
            "in": "query",
            "description": "Filter contact persons by a list of IDs. Returns only contacts matching these IDs.\nUse comma-separated values for multiple IDs.\n",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int64"
              }
            },
            "style": "form",
            "explode": false,
            "example": "123,456,789"
          },
          {
            "name": "profileId",
            "in": "query",
            "description": "Filter contact persons by profile ID (shows only contacts linked to this profile via profile_persons)",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "firstName",
            "in": "query",
            "description": "Search term to filter contact persons by firstName (case-insensitive contains)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "lastName",
            "in": "query",
            "description": "Search term to filter contact persons by lastName (case-insensitive contains)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "email",
            "in": "query",
            "description": "Search term to filter contact persons by email (case-insensitive contains)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sort contact persons by field and direction in format: field:direction\nMultiple fields can be separated by semicolon.\nExamples: lastName:asc, firstName:desc, lastName:asc;firstName:desc\nValid fields: firstName, lastName, email, createdAt, updatedAt\nValid directions: asc, desc (default: asc)\nDefault sort: lastName:asc\n",
            "required": false,
            "schema": {
              "type": "string",
              "default": "lastName:asc"
            },
            "example": "lastName:asc"
          },
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/limit"
          }
        ],
        "responses": {
          "200": {
            "description": "Contact persons retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ContactPersonListResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Profile not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "parameters": {
      "xPropertyId": {
        "name": "x-property-id",
        "in": "header",
        "description": "Property ID",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      "xOrganizationId": {
        "name": "x-organization-id",
        "in": "header",
        "description": "Organization ID",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      "pageToken": {
        "name": "pageToken",
        "in": "query",
        "description": "Cursor token for pagination. Use the `nextPageToken` from the previous response to fetch the next page.\n\n**Usage:**\n- Omit or pass empty string for the first page\n- Pass the `nextPageToken` from previous response for subsequent pages\n- When `nextPageToken` is null in the response, you've reached the last page\n\n**Benefits over offset-based pagination:**\n- Consistent results even when data changes between requests\n- Better performance for large datasets (no row skipping)\n- No maximum page limit\n",
        "required": false,
        "schema": {
          "type": "string"
        },
        "example": ""
      },
      "limit": {
        "name": "limit",
        "in": "query",
        "description": "Page size. Specifies the maximum number of items to return in a single response.\n\n**Limits:**\n- Minimum: 1\n- Maximum: 500\n- Default: 100\n",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 500,
          "default": 100
        },
        "example": 100
      }
    },
    "schemas": {
      "CursorPagination": {
        "type": "object",
        "description": "Cursor-based pagination metadata for list responses",
        "properties": {
          "nextPageToken": {
            "type": "string",
            "nullable": true,
            "description": "Token to fetch the next page of results.\nPass this value as the `pageToken` query parameter in the next request.\nWhen null, there are no more pages available.\n"
          }
        }
      },
      "ContactPersonResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Contact person ID"
          },
          "isMainContact": {
            "type": "boolean",
            "description": "Whether this is the main contact (from profile-person relationship, only populated when profileId filter was provided)"
          },
          "role": {
            "$ref": "#/components/schemas/contactRole",
            "description": "Role of the contact person (from profile-person relationship, only populated when profileId filter was provided)"
          },
          "relationshipType": {
            "$ref": "#/components/schemas/relationshipType",
            "description": "Type of relationship between person and profile (from profile-person relationship, only populated when profileId filter was provided)"
          },
          "startDate": {
            "type": "string",
            "format": "date",
            "description": "Start date of the relationship (from profile-person relationship, only populated when profileId filter was provided)"
          },
          "endDate": {
            "type": "string",
            "format": "date",
            "description": "End date of the relationship (from profile-person relationship, only populated when profileId filter was provided)"
          },
          "anonymized": {
            "type": "boolean",
            "description": "Whether the contact is anonymized",
            "default": false
          },
          "prefix": {
            "type": "string",
            "maxLength": 5,
            "description": "Name prefix (Mr., Mrs., Dr., etc.)",
            "example": "Mr."
          },
          "firstName": {
            "type": "string",
            "maxLength": 100,
            "description": "First name",
            "example": "John"
          },
          "lastName": {
            "type": "string",
            "maxLength": 100,
            "description": "Last name",
            "example": "Doe"
          },
          "emails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContactEmail"
            },
            "description": "Email addresses with types"
          },
          "phones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContactPhone"
            },
            "description": "Phone numbers with types"
          },
          "status": {
            "$ref": "#/components/schemas/ContactStatus"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Creation timestamp"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Last update timestamp"
          },
          "billingDetails": {
            "$ref": "#/components/schemas/BillingDetails"
          }
        }
      },
      "ContactEmail": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Email ID",
            "readOnly": true
          },
          "contactPersonId": {
            "type": "string",
            "description": "Contact person ID",
            "readOnly": true
          },
          "emailType": {
            "type": "string",
            "maxLength": 50,
            "description": "Email type (work, personal, etc.)",
            "example": "work"
          },
          "email": {
            "type": "string",
            "format": "email",
            "maxLength": 255,
            "description": "Email address",
            "example": "john.doe@example.com"
          },
          "primary": {
            "type": "boolean",
            "description": "Whether this is the primary email",
            "default": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Creation timestamp",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Last update timestamp",
            "readOnly": true
          }
        }
      },
      "ContactPhone": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Phone ID",
            "readOnly": true
          },
          "contactPersonId": {
            "type": "string",
            "description": "Contact person ID",
            "readOnly": true
          },
          "phoneType": {
            "type": "string",
            "maxLength": 50,
            "description": "Phone type (work, mobile, home, etc.)",
            "example": "mobile"
          },
          "phone": {
            "type": "string",
            "maxLength": 50,
            "description": "Phone number",
            "example": "+1-555-123-4567"
          },
          "primary": {
            "type": "boolean",
            "description": "Whether this is the primary phone",
            "default": false
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Creation timestamp",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Last update timestamp",
            "readOnly": true
          }
        }
      },
      "ContactStatus": {
        "type": "string",
        "description": "Contact person status. Allowed values are ACTIVE, DELETED",
        "example": "ACTIVE"
      },
      "ContactPersonListResponse": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ContactPersonResponse"
                }
              }
            }
          },
          {
            "$ref": "#/components/schemas/CursorPagination"
          }
        ]
      },
      "BillingDetails": {
        "type": "object",
        "description": "Billing details for profiles and contact persons",
        "properties": {
          "billingEntity": {
            "type": "boolean",
            "description": "Whether this is a billing entity"
          },
          "legalName": {
            "type": "string",
            "maxLength": 255,
            "description": "Legal name for billing purposes"
          },
          "billingEmail": {
            "type": "string",
            "format": "email",
            "maxLength": 255,
            "description": "Billing email address"
          },
          "billingAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "billingCurrency": {
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "pattern": "^[A-Z]{3}$",
            "description": "Billing currency code (ISO 4217 - 3 uppercase letters, e.g., USD, EUR, GBP)",
            "example": "USD"
          },
          "paymentMethod": {
            "$ref": "#/components/schemas/PaymentMethod"
          },
          "billingInstructions": {
            "type": "string",
            "description": "Special billing instructions"
          },
          "invoiceRecipientEmail": {
            "type": "string",
            "format": "email",
            "maxLength": 255,
            "description": "Email address for invoice delivery"
          },
          "creditLimit": {
            "type": "number",
            "description": "Credit limit amount"
          },
          "taxId": {
            "type": "string",
            "maxLength": 100,
            "description": "Tax identification number"
          },
          "billingFrequency": {
            "$ref": "#/components/schemas/BillingFrequency"
          },
          "invoiceDueDays": {
            "type": "integer",
            "minimum": 0,
            "description": "Number of days until invoice is due"
          }
        }
      },
      "Address": {
        "type": "object",
        "description": "Flexible address object with country-specific fields.\nThe countryCode determines the expected address format.\nAll address fields except id and countryCode are stored as dynamic properties.\nCommon fields include: address1, address2, street, number, city, state, zip, etc.\n",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "Unique identifier for the address",
            "readOnly": true
          },
          "countryCode": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[A-Z]{2}$",
            "description": "ISO 3166-1 alpha-2 country code (determines address format)"
          }
        },
        "additionalProperties": true
      },
      "PaymentMethod": {
        "type": "string",
        "enum": [
          "DIRECT_BILL",
          "CASH",
          "CHECK",
          "CREDIT_CARD",
          "DEBIT_CARD",
          "VOUCHER",
          "PAY_BY_LINK",
          "THIRD_PARTY_PAYMENT"
        ],
        "description": "Payment method. Allowed values are DIRECT_BILL, CASH, CHECK, CREDIT_CARD, DEBIT_CARD, VOUCHER, PAY_BY_LINK, THIRD_PARTY_PAYMENT",
        "example": "CREDIT_CARD"
      },
      "BillingFrequency": {
        "type": "string",
        "enum": [
          "PER_STAY",
          "WEEKLY",
          "MONTHLY",
          "ON_DEMAND"
        ],
        "description": "Billing frequency. Allowed values are PER_STAY, WEEKLY, MONTHLY, ON_DEMAND",
        "example": "MONTHLY"
      },
      "contactRole": {
        "type": "string",
        "enum": [
          "BOOKING_COORDINATOR",
          "ONSITE_COORDINATOR",
          "ROOMING_LIST_CONTACT",
          "ACCOUNTS_PAYABLE",
          "BILLING",
          "INVOICING",
          "ACCOUNT_MANAGER",
          "SALES_LEAD",
          "TRAVEL_AGENT_ACCOUNT_MANAGER",
          "CORPORATE_CONTACT",
          "AUTHORIZED_SIGNER",
          "EXECUTIVE_APPROVER",
          "MARKETING",
          "MAIN_POINT_OF_CONTACT",
          "ADMINISTRATIVE",
          "OTHER"
        ],
        "description": "Role of person in the profile relationship",
        "example": "BOOKING_COORDINATOR"
      },
      "relationshipType": {
        "type": "string",
        "enum": [
          "EMPLOYEE",
          "BOOKED_BY",
          "PART_OF_GROUP",
          "CONTACT",
          "GUEST",
          "DECISION_MAKER",
          "TRAVELER",
          "PRIMARY",
          "SECONDARY",
          "BILLING_CONTACT",
          "EMERGENCY_CONTACT"
        ],
        "description": "Type of relationship between person and profile",
        "example": "PRIMARY"
      },
      "ApiError": {
        "type": "object",
        "description": "Standard error response for 4xx and 5xx errors (except validation errors).\n\n## Error Codes\n\n### Validation Errors (400)\n- `INVALID_REQUEST` - The request body is invalid or malformed\n- `INVALID_PARAMETER` - One or more request parameters are invalid\n- `INVALID_ENUM_VALUE` - Invalid enum value provided\n- `INVALID_JSON` - The request body contains malformed JSON\n\n### Resource Errors (404)\n- `RESOURCE_NOT_FOUND` - The requested resource was not found\n- `PROFILE_NOT_FOUND` - Profile not found\n- `NOTE_NOT_FOUND` - Note not found\n- `TAG_NOT_FOUND` - Tag not found\n\n### Conflict Errors (409)\n- `RESOURCE_ALREADY_EXISTS` - The resource already exists\n- `DUPLICATE_PROFILE_CODE` - A profile with this code already exists\n- `DUPLICATE_RELATIONSHIP` - This relationship already exists\n\n### Authorization Errors (403)\n- `ACCESS_DENIED` - Access denied to the requested resource\n- `ORGANIZATION_MISMATCH` - Resource belongs to a different organization\n\n### Server Errors (500)\n- `INTERNAL_ERROR` - An unexpected error occurred\n- `DATABASE_ERROR` - A database error occurred\n",
        "properties": {
          "message": {
            "type": "string",
            "description": "Human-readable error message explaining what went wrong",
            "example": "A profile with this code already exists. Please use a unique code."
          },
          "code": {
            "type": "string",
            "description": "Machine-readable error code for programmatic error handling",
            "example": "DUPLICATE_PROFILE_CODE"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "ISO 8601 timestamp when the error occurred",
            "example": "2024-01-15T10:30:45.123Z"
          }
        }
      }
    }
  }
}
```