---
title: "Returns a list of guest profiles"
method: GET
path: "/profiles"
tags: ["Profiles"]
---

# Returns a list of guest profiles

`GET /profiles`

## Request

- Base URL: `/guest-profiles/v1` (relative, and the document’s source URL is not known)
- URL: `/guest-profiles/v1/profiles`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `/oauth/authorize`
    - Token URL: `/oauth/token` scopes: `read:guest`

## Query parameters

- `offset` number
- `limit` number
- `includeTotal` boolean
- `filter` string
- `sort` string

## Headers

- `X-Organization-Id` string, required

## Response `200`

Response

- ProfilesResponse
  - `offset` number: Offset of the total number of results
  - `limit` number: Results page size
  - `total` number: Total number of results
  - `data` ProfileResponse[]: List of profiles returned
    - `photoId` number: Photo ID
    - `taxId` string: Tax ID
    - `companyTaxId` string: Company tax ID
    - `statusId` number: Profile Status ID. Deprecated: Use statuses instead.
    - `firstName` string: First name
    - `lastName` string: Last name
    - `email` string: Email address
    - `phone` string: Phone number
    - `cellPhone` string: Cellphone number
    - `birthday` string, date: Birthday
    - `gender` string: Gender
    - `companyName` string: Company name
    - `address1` string: Address line 1
    - `address2` string: Address line 2
    - `city` string: City
    - `country` string: Two digit Country Code. ISO 3166-1 alpha-2
    - `countryName` string: Country name
    - `state` string: State
    - `zip` string: ZIP code
    - `documentType` string: Document type
    - `documentNumber` string: Document number
    - `documentIssueDate` string, date: Document issue date
    - `documentIssuingCountry` string: Document issue country. ISO 3166-1 alpha-2
    - `documentExpirationDate` string, date: Document expiration date
    - `isOptIn` boolean: Opt-in status
    - `id` string: Profile's unique identifier
    - `organizationId` string: Organization ID
    - `statusName` string: Profile Status Name. Deprecated: Use statuses instead.
    - `statuses` object[]: All statuses for this profile across all properties
      - `id` integer: Status ID
      - `name` string: Status name
    - `isMerged` boolean: Merged status. Merged profiles are no longer active in the Cloudbeds system
    - `isRepeatGuest` boolean: Repeat-guest status
    - `dateCreated` string, date-time: Creation date. Date/Time string based on RFC 3339 (Y-m-dTH:i:sP)
    - `dateModified` string, date-time: Modification date. Date/Time string based on RFC 3339 (Y-m-dTH:i:sP)
    - `dateAnonymized` string, date-time: Anonymization date. Date/Time string based on RFC 3339 (Y-m-dTH:i:sP)
    - `parentId` string: Profile's parent unique identifier
    - `photo` ProfilePhoto
      - `fileId` string: Photo unique identifier
      - `path` string: Photo URL
      - `croppedImage` string: Cropped photo URL
      - `height` integer: Photo height
      - `width` integer: Photo width
      - `cropParam` object: Crop parameters
        - `width` number: Cropped photo width
        - `height` number: Cropped photo height
        - `x` number: X coordinate of the top-left corner of the cropped photo
        - `y` number: Y coordinate of the top-left corner of the cropped photo
    - `isAnonymizationAvailable` boolean: Anonymization availability status

---

[API](https://skmtc.dev/cloudbeds/apis/guest-profile-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/guest-profile-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/guest-profile-api/revisions/df6e85914ec0?raw)