Support center

API with shows in JSON format

The agency can approve shows to be published for web. Once approved, the shows appear within 30 minutes in the API.

You can find the API endpoint with JSON data for your agency through the Embed shows on your site page, which you can use to experiment with the parameters as well.

Parameters

The API takes the following parameters in querystring.

  • upcoming_limit [number of days]
    Cutoff for filtering how far shows in the future will be displayed.
  • past_limit [number of days]
    Cutoff for filtering how far shows in the past will be displayed.
  • lang [en, nl, de, es, pt]
    Localize the day, month names.
  • artistIds [system one ids]
    Filters the response by artist(s). If you want to filter for multiple artists, separate the ids by comma.
  • productionIds [system one id]
    Filters the response by production(s)
  • cancelled=true [boolean]
    Include cancelled shows in the result
  • per_page
    The data is paginated; per_page will set how many items there are on a page.
  • page
    Data is paginated; page will set what part of the resultset is returned.

Response

The API responds with JSON formatted data. Most values are self-explanatory.

Status.Phase
Indicates the status of the show

  • D = Definitive
  • C = Cancelled
  • O = Option

Tickets
Node is only displayed when tickets URL is specified.

Production
Some agencies use a productions module. Shows belong to a certain production.

Doors
This node has the properties 

  • open
  • close

The value is optional and when provided has a 24h time (hh:mm) 

LPT: We found the Chrome JSONView plugin a useful tool to quickly inspect JSON output.

Related articles: