---
title: "Get custom fields for a profile"
method: GET
path: "/profiles/{profileId}/custom-fields"
tags: ["Profiles"]
---

# Get custom fields for a profile

`GET /profiles/{profileId}/custom-fields`

## Request

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

## Path parameters

- `profileId` number, required

## Headers

- `X-Organization-Id` string, required

## Response `200`

Response

- GetProfileCustomFieldsResponse
  - `data` GuestCustomField[]: List of custom fields returned
    - `id` string: Guest custom field unique identifier
    - `customFieldId` string: Custom field unique identifier
    - `name` string: Custom field name
    - `value` string: Custom field value
    - `label` string: Custom field label
    - `type` string: Custom field type
    - `isPersonal` number: Is custom field personal or not
    - `order` number: Custom field order
    - `maxLen` number: Custom field value max length
    - `required` number: Is custom field required or not

---

[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)