Skip to content

Get Booking User for Attendance

Request

Retrieve one Booking User profile used by the attendance workflow as a JSON:API resource object.

The client_id path parameter and client resource type are literal legacy wire names. Optional related data is returned only when requested through include and may require additional Business User permissions or enabled Location features.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

client_idinteger, >= 1required

Booking User profile ID; client_id is the literal wire name

Query
includeArray of strings, unique(Booking User Includes)

Related resources to include; values are literal API keys

Items Enum:"labels""first_successful_visit""loyalty_cards""loyalty_certificates""loyalty_abonements""custom_field_values""agreements"
Headers
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}/attendance/clients/{client_id}?include=labels' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Booking User retrieved successfully

Bodyapplication/json
dataobject(Booking User Resource)required
metaArray of any, <= 0 itemsrequired
includedArray of objects(includedResource)

Resources requested through include, when available

Response
{
  "data": {
    "type": "client",
    "id": "string",
    "attributes": { … },
    "relationships": { … }
  },
  "included": [
    { … }
  ],
  "meta": []
}