CLcloudbeds
ProfileDocument

Get profile document metadata by ID

Get metadata for a specific document

get/group-profile/v1/profiles/{profileId}/documents/{documentId}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/group-profile/v1/profiles/{profileId}/documents/{documentId}
  • Auth
    HTTP bearer

Path parameters

profileIdinteger required

Entity ID

documentIdinteger required

Document ID

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Response

Profile document retrieved successfully

idstring required

Unique identifier for the profile document

profileIdstring required

ID of the profile (group, company, or travel agent)

userIdstring required

User ID of the person who uploaded the document

fileNamestring required

Original file name of the uploaded document

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

Example response

{
  "id": "12345",
  "profileId": "67890",
  "userId": "54321",
  "fileName": "contract.pdf"
}

Changes

No recorded changes to this operation across all 1 revision of this API.