Get a list of venues

Once a bearer token has been generated, you may use this auth token to obtain a list of venues. You will only be able to view venues that are listed in the organisation that your client_id is assigned to. If your auth key is assigned to a sub-organisation then only the venues in that sub-organisation will be shown.

Request

Method: GET
URL: https://global.stampede.ai/v1/venues
Auth: Bearer token

The following values may be sent as query parameters.

Response

{
  "data": [
    {
      "id": string,
      "name": string | null,
      "organization_id": string,
      "branding_settings": {
        "headerImage": string,
        "headerColor": string,
        "interfaceColor": string,
        "background": string,
        "backgroundImage": string | null
      }
    }
  ],
  "links": {
    "first": string | null,
    "last": string | null,
    "next": string | null,
    "prev": string | null
  }
}

Examples

To retrieve all venues on one response:

https://global.stampede.ai/v1/venues

Limit the responses to 5 per page:

https://global.stampede.ai/v1/venues?limit=5

Paging through results

If you wish to page through results then this can be done by sending the links value as a variable for the name cursor. Say for example your total results are 25 venues and you are showing 5 per page. You will receive a links result at the bottom of the data response like so:

"links": {
    "first": null,
    "last": null,
    "next": "YRZOXXXASSKG",
    "prev": null
}

To obtain the next page of results you would then send the value returned for the next string e.g.

https://global.stampede.ai/v1/venues?limit=5&cursor=YRZOXXXASSKG

This will then return the next page of 5 results. The same principle can be used for the previous page.