BizKitHub
DocsAPI ReferenceCustomer/api/v1/customer/event-access
getCustomerPublic API v1

/api/v1/customer/event-access

Returns the smart-lock access code of a reservation for the logged-in customer. Allowed only for an event the customer has a paid, not cancelled order line for, or is an attendee of (shared training); otherwise PUBLIC_CALENDAR_EVENT_DOES_NOT_EXIST (404). The code is returned no earlier than the calendar-event-ping e-mail is sent and never after the event ends. status: ready (own code), backup (the lock's backup code was used), not_generated, no_lock, failed (generation failed and no backup was available), not_yet_available (access e-mail not sent yet), expired, cancelled. password, startDate and endDate are present only with ready / backup.

customergetApiV1CustomerEvent-access

Parameters

3 query

Query parameters

· 3
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg
eventCodestringRequired

Calendar event code (lines[].event.id in GET /customer/order-list).

Length: 1–32
Example7lRIAiC69gZMfwsDbG3CJvQdqnY15XdS

Response schema

1 status code documented

200Success
eventCodestringRequired
Example7lRIAiC69gZMfwsDbG3CJvQdqnY15XdS
status"ready" | "backup" | "not_generated" | "no_lock" | "failed" | "not_yet_available" | "expired" | "cancelled"Required

Access code state, see the endpoint description.

Exampleready
passwordstringOptional

Keypad code.

Example48213907
startDateDate | string | string | numberOptional

Code valid from.

One of 4:
Variant 1
Date

Code valid from.

Example2026-11-08T09:59:00.000Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
endDateDate | string | string | numberOptional

Code valid until.

One of 4:
Variant 1
Date

Code valid until.

Example2026-11-08T11:05:00.000Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
eventStartTimeDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2026-11-08T10:00:00.000Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
eventEndTimeDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2026-11-08T11:00:00.000Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number

Response example

application/json
{
  "eventCode": "7lRIAiC69gZMfwsDbG3CJvQdqnY15XdS",
  "status": "ready",
  "password": "48213907",
  "startDate": "2026-11-08T09:59:00.000Z",
  "endDate": "2026-11-08T11:05:00.000Z",
  "eventStartTime": "2026-11-08T10:00:00.000Z",
  "eventEndTime": "2026-11-08T11:00:00.000Z"
}

Request example

GET /api/v1/customer/event-access

get
curl -X GET "https://api.bizkithub.com/api/v1/customer/event-access?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&eventCode=7lRIAiC69gZMfwsDbG3CJvQdqnY15XdS" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key