List venues

GET

/public/v1/venues

const url = 'https://example.kwickbooking.com/public/v1/venues';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.kwickbooking.com/public/v1/venues \
  --header 'Authorization: Bearer <token>'

Lists the venues this key can use, with address and time zone. Use a venue id from here wherever an operation takes venueId.

Authorizations

IntegrationKey

Responses

200

application/json

GET /public/v1/venues: the key’s venues and a one-line summary.

object

venues

required

Array<object>

A venue an integration key can see.

object

required

string format: uuid

name

required

string

slug

required

string

timezone

required

string

address

required

One of:

null
object

null

description

required

null | string

summary

required

string

Example

{
  "venues": [
    {
      "id": "01920000-0000-7000-8000-000000000001",
      "name": "Soho",
      "slug": "soho",
      "timezone": "Europe/London",
      "address": {
        "line1": "12 Greek Street",
        "line2": null,
        "city": "London",
        "postcode": "W1D 4DL",
        "country": "GB"
      },
      "description": "Cocktail bar with live music."
    }
  ],
  "summary": "1 venue: Soho"
}

401

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

application/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

invalid-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."
}

403

Capability not granted (https://developers.kwickblocks.ai/problems/capability-missing)

application/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

capability-missing

Capability not granted

{
  "type": "https://developers.kwickblocks.ai/problems/capability-missing",
  "title": "Capability not granted",
  "status": 403,
  "detail": "This integration key isn't allowed to do that. Ask the venue's admin to add the capability."
}

429

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

application/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

rate-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."
}