Venues

This endpoint is used for managing venue data

Get venues

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/venues

Returns an array of all venues which the authenticated user is authorised to view. The response will be paginated.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstring · enumOptional

Filters by the status of the venue.

Example: publicPossible values:

titlestringOptional

Filters by venues where the start of the title matches the venue's title. For example, filtering by "Bar" will return "Bar Collins", but filtering by "Collins" will not return "Bar Collins".

Example: Bar Collins

limitinteger · min: 1 · max: 30Optional

Limit the response to the specified number of records.

Default: 30Example: 30

sortstring[]Optional

The fields which the results should be sorted by. If this value is not specified, the records will be sorted in order of relevance to the query parameter. If the query parameter is not specified, records will be sorted in order of their created_date. To sort in decending order, prefix the field name with a '-' character.

Example: -last_updated

pagestringOptional

The page number to retrieve results for. Learn more about pagination

Default: 1Example: 2

Responses

200

Venues were successfully retrieved.

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

get

/venues

HTTPcURLJavaScriptPython

GET /api/venues HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "venues": [
    {
      "id": "5cab15dbff3b7aae0090ad44",
      "title": "Bar Collins",
      "venue_group": "5cab162d8589744d72dbbc2b",
      "manage_own_bookings": true,
      "status": "public",
      "store_code": "123",
      "address": {
        "building_name": "23-28",
        "street": "Penn Street",
        "city": "London",
        "postcode": "N1 5DL"
      },
      "tags": [
        "5d5acedb672f350a91796e05"
      ],
      "created_date": "2020-01-01 13:30:00",
      "last_updated": "2020-01-01 13:30:00"
    }
  ]
}

Get a venue

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/venues/{venueId}

Returns details about a specific venue

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

venueIdstringRequired

The ID of the venue you want to retrieve

Responses

200

The venue was successfully retrieved.

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

get

/venues/{venueId}

HTTPcURLJavaScriptPython

GET /api/venues/{venueId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "venue": {
    "id": "5cab15dbff3b7aae0090ad44",
    "title": "Bar Collins",
    "venue_group": "5cab162d8589744d72dbbc2b",
    "manage_own_bookings": true,
    "status": "public",
    "store_code": "123",
    "address": {
      "building_name": "23-28",
      "street": "Penn Street",
      "city": "London",
      "postcode": "N1 5DL"
    },
    "tags": [
      "5d5acedb672f350a91796e05"
    ],
    "created_date": "2020-01-01 13:30:00",
    "last_updated": "2020-01-01 13:30:00"
  }
}

Get active marketing preferences

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/venues/{venueId}/marketing-preferences

Returns an array of active marketing preferences for the given venue. An active marketing preference is one which has been set up on the venue group level and activated on the individual venue.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

venueIdstringRequired

The venue ID to retrieve marketing preferences for

Responses

200

The active marketing preferences were successfully retrieved

application/json

idstringOptional

The ID of this marketing preference

Example: 5b0743f00000000000000000

namestringOptional

The name of this marketing preference

Example: SMS

descriptionstringOptional

A description of this marketing preference

Example: I am happy for Test Venue to contact me over SMS for exclusive offers

created_datestring · dateOptional

The date when this marketing preference was created

Example: 2019-03-13 22:09:30

get

/venues/{venueId}/marketing-preferences

HTTPcURLJavaScriptPython

GET /api/venues/{venueId}/marketing-preferences HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The active marketing preferences were successfully retrieved

[
  {
    "id": "5b0743f00000000000000000",
    "name": "SMS",
    "description": "I am happy for Test Venue to contact me over SMS for exclusive offers",
    "created_date": "2019-03-13 22:09:30"
  }
]