Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Profiles

Returns a single profile by ID

get/profiles/{profileId}

Path parameters

profileIdnumber required
Example:226973

Profile ID

Headers

X-Organization-Idstring required

Organization ID

Response

Response

photoIdnumber

Photo ID

taxIdstring

Tax ID

companyTaxIdstring

Company tax ID

statusIdnumber

Profile Status ID. Deprecated: Use statuses instead.

firstNamestring

First name

lastNamestring

Last name

emailstring

Email address

phonestring

Phone number

cellPhonestring

Cellphone number

birthdaystring date

Birthday

genderstring

Gender

companyNamestring

Company name

address1string

Address line 1

address2string

Address line 2

citystring

City

countrystring

Two digit Country Code. ISO 3166-1 alpha-2

countryNamestring

Country name

statestring

State

zipstring

ZIP code

documentTypestring

Document type

documentNumberstring

Document number

documentIssueDatestring date

Document issue date

documentIssuingCountrystring

Document issue country. ISO 3166-1 alpha-2

documentExpirationDatestring date

Document expiration date

isOptInboolean

Opt-in status

idstring

Profile's unique identifier

organizationIdstring

Organization ID

statusNamestring

Profile Status Name. Deprecated: Use statuses instead.

isMergedboolean

Merged status. Merged profiles are no longer active in the Cloudbeds system

isRepeatGuestboolean

Repeat-guest status

dateCreatedstring date-time

Creation date. Date/Time string based on RFC 3339 (Y-m-dTH:i:sP)

dateModifiedstring date-time

Modification date. Date/Time string based on RFC 3339 (Y-m-dTH:i:sP)

dateAnonymizedstring date-time

Anonymization date. Date/Time string based on RFC 3339 (Y-m-dTH:i:sP)

parentIdstring

Profile's parent unique identifier

isAnonymizationAvailableboolean

Anonymization availability status

Example response

{
  "photoId": 12345,
  "taxId": "12345",
  "companyTaxId": "12345",
  "statusId": 12,
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "123456789",
  "cellPhone": "123456789",
  "birthday": "1970-01-01",
  "gender": "M",
  "companyName": "Company",
  "address1": "Address line 1",
  "address2": "Address line 2",
  "city": "City",
  "country": "US",
  "countryName": "United States",
  "state": "State",
  "zip": "12345",
  "documentType": "driver_licence",
  "documentNumber": "123456789",
  "documentIssueDate": "1970-01-01",
  "documentIssuingCountry": "US",
  "documentExpirationDate": "1970-01-01",
  "id": "123456788",
  "organizationId": "12345",
  "statusName": "VIP",
  "statuses": [
    {
      "id": 1,
      "name": "VIP"
    },
    {
      "id": 2,
      "name": "Regular"
    }
  ],
  "dateCreated": "2024-08-06T13:38:35+00:00",
  "dateModified": "2024-08-06T16:58:59+00:00",
  "dateAnonymized": "2024-08-06T16:58:59+00:00",
  "parentId": "123456789",
  "photo": {
    "fileId": "12345",
    "path": "https://amazonaws.com/photo-jumbo~~67816f854de79.jpg",
    "croppedImage": "https://amazonaws.com/photo-jumbo_thumb~~67816f857ccab.jpg",
    "height": 797,
    "width": 1000,
    "cropParam": {
      "width": 75.140625,
      "height": 75.140625,
      "x": 212.12890625,
      "y": 210.203125
    }
  },
  "isAnonymizationAvailable": true
}