Skip to content
Kwickblocks Developers

Widget configuration

GET
/public/v1/venues/{id}/widget-config
curl --request GET \
  --url https://example.kwickbooking.com/public/v1/venues/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/widget-config \
  --header 'X-KB-Publishable-Key: <X-KB-Publishable-Key>'

The venue’s logo, colours, wording and enabled booking flows for the booking widget.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

The venue’s widget theme, wording and enabled booking flows.

object
venueId
required
string format: uuid
logoUrl
required
null | string
palette
required
object
key
additional properties
string
copy
required
object
key
additional properties
string
enabledFlows
required
Array<string>
Example
{
  "venueId": "01920000-0000-7000-8000-000000000001",
  "logoUrl": null,
  "palette": {
    "primary": "#2572FB"
  },
  "copy": {},
  "enabledFlows": [
    "booking",
    "enquiry"
  ]
}

401

Section titled “401”

Invalid or missing integration key (https://developers.kwickblocks.ai/problems/invalid-key)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object
type
required
string format: uri
title
required
string
status
required
integer format: int32
detail
required

Safe to read to a guest.

string
instance
string
traceId
string
code

A machine-readable code on the widget’s routes.

string
Examples
Exampleinvalid-key

Invalid or missing integration key

{
  "type": "https://developers.kwickblocks.ai/problems/invalid-key",
  "title": "Invalid or missing integration key",
  "status": 401,
  "detail": "This integration key isn't valid. Ask the venue's admin for a new one."
}

404

Section titled “404”

Not found (https://developers.kwickblocks.ai/problems/not-found)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object
type
required
string format: uri
title
required
string
status
required
integer format: int32
detail
required

Safe to read to a guest.

string
instance
string
traceId
string
code

A machine-readable code on the widget’s routes.

string
Examples
Examplenot-found

Not found

{
  "type": "https://developers.kwickblocks.ai/problems/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "I couldn't find that."
}

429

Section titled “429”

Too many requests (https://developers.kwickblocks.ai/problems/rate-limited)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object
type
required
string format: uri
title
required
string
status
required
integer format: int32
detail
required

Safe to read to a guest.

string
instance
string
traceId
string
code

A machine-readable code on the widget’s routes.

string
Examples
Examplerate-limited

Too many requests

{
  "type": "https://developers.kwickblocks.ai/problems/rate-limited",
  "title": "Too many requests",
  "status": 429,
  "detail": "There have been too many requests. Please try again in a minute."
}