v1

latestOpenAPI 3.1.1Altegio API Agreement2026-08-064243217.4 KB
Custom Fields

List Custom Fields

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].

get/locations/{location_id}/custom_fields

Path parameters

location_idinteger required

Location ID

Query parameters

filter[parent_entity_type]'record' | 'client'

Filter by Appointment or Booking User wire entity value

filter[entity_slug]'record' | 'client'

Compatibility alias for filter[parent_entity_type]

includestring[]

Include Custom Field type or interface options

Headers

Acceptstring required

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

Authorizationstring required

Bearer {partner_token}, User {user_token}

Response

Custom Fields retrieved successfully