List Custom Fields

Request

Retrieve Custom Fields configured for Appointments and Booking Users in a Location. Access depends on the Business User's Custom Field permissions.

The literal record and client filter values mean Appointment and Booking User respectively. filter[entity_slug] is a compatibility alias for filter[parent_entity_type].

Security

BearerPartnerUser

Path

location_idintegerrequired

Location ID

Query

filter[parent_entity_type]string

Filter by Appointment or Booking User wire entity value

Enum:"record""client"

filter[entity_slug]stringdeprecated

Compatibility alias for filter[parent_entity_type]

Enum:"record""client"

includeArray of strings, unique

Include Custom Field type or interface options

Items Enum:"custom_field_type""ui_options"

Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"

Example:application/vnd.api.v2+json

Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/custom_fields?filter%5Bparent_entity_type%5D=record&filter%5Bentity_slug%5D=record&include=custom_field_type' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Custom Fields retrieved successfully

Bodyapplication/json

dataArray of objects(Custom Field Resource)required

includedArray of any

Resources requested through include, when available

Response

{
  "data": [
    { … }
  ]
}