Skip to content
Kwickblocks Developers

Get a venue

GET
/public/v1/venues/{id}
curl --request GET \
  --url https://example.kwickbooking.com/public/v1/venues/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns a venue’s name, address, description, brand and the booking types guests can book online. Call it before booking to learn which booking types the venue offers.

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

GET /public/v1/venues/{id}: the frozen fields (id, name, slug, timezone) plus address, description, brand and online-bookable booking types, and a summary.

object
id
required
string format: uuid
name
required
string
slug
required
string
timezone
required
string
address
required
One of:
null
description
required
null | string
brandName
required
string
bookingTypes
required
Array<object>

A booking type a guest can book online at the venue.

object
id
required
string format: uuid
name
required
string
kind
required
string
summary
required
string
Example
{
  "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.",
  "brandName": "Greek Street Bars",
  "bookingTypes": [
    {
      "id": "01920000-0000-7000-8000-000000000003",
      "name": "Table booking",
      "kind": "Reservation"
    }
  ],
  "summary": "Soho, 12 Greek Street, London"
}

400

Section titled “400”

Venue required (https://developers.kwickblocks.ai/problems/venue-required)

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
Examplevenue-required

Venue required

{
  "type": "https://developers.kwickblocks.ai/problems/venue-required",
  "title": "Venue required",
  "status": 400,
  "detail": "Please say which venue this is for."
}

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

403

Section titled “403”

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

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

404

Section titled “404”

Venue not found (https://developers.kwickblocks.ai/problems/venue-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
Examplevenue-not-found

Venue not found

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

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