API reference
List events
With this API you can list all events of the selected organisation.
Request
Make a GET request to the following endpoint with the API Key.
https://api.hipsy.nl/v1/organisation/{organisation-slug}/events
The URL parameter organsation-slug is the slug of the organisation to get the events from. This slug can be found in the Hipsy dashboard in menu 'Organisatie' and tab 'Profiel'. Or you can retrieve the slug in the List organisatie API.
Changing the slug
Be aware that if you change the slug of the organisation in the Hipsy dashboard, you need to update your API endpoints as well.
The following parameters are available and can be passed in the URL as GET parameters.
| Parameter | Required | Description | Default |
|---|---|---|---|
| period | optional | Can be either past, upcoming or all | upcoming |
| limit | optional | Can return up to 100 events | 25 |
| page | optional | Page selection in case there are more results than the given limit. | 1 |
Response
An array will be returned with the events.
| Key | Description |
|---|---|
| id | The ID of the event |
| title | The title of the event |
| location | The location of the event |
| latitude | The latitude of the location of the event |
| longitude | The longitude of the location of the event |
| picture | URL of the picture of the event |
| picture_small | URL of the small picture of the event |
| date | Date of the event when the event start |
| date_until | Date of the event when the event ends |
| url_hipsy | URL to the event page on the Hipsy website |
| url_ticketshop | URL to the ticketshop of the event |
| qr_ticketshop | QR image which contain the URL to the ticketshop |
| tickets | Array of the configured tickets of the event. See table tickets array |
Tickets array
| Key | Description |
|---|---|
| id | The ID of the configured ticket |
| type | Can be either ticket or donation |
| name | Name of the configured ticket |
| description | Description of the configured ticket |
| price | Price of the configured ticket |
| status | Can be either sale, sold, insible or not_available |
| available | The amount of tickets available to buy. If unlimited the value will be 99999. |
| sale_start | Start date when the ticket is available to buy. Will be null if not provided |
| sale_end | End date until the ticket is available to buy. Will be null if not provided |
Example
{
"data": [
{
"id": 1032,
"title": "Ecstatic Dance Universe - Kareem",
"description": "Description of the event\n\nAll the info of the event",
"location": "Amersfoort, Nederland",
"latitude": "52.1561113",
"longitude": "5.3878266",
"picture": "https:\/\/cdn.hipsy.nl\/images\/events\/pic1.jpg",
"picture_small": "https:\/\/cdn.hipsy.nl\/images\/events\/pic1.jpg",
"date": "2023-03-01T20:07:00.000000Z",
"date_until": "2023-02-28T23:07:00.000000Z",
"url_hipsy": "https:\/\/hipsy.nl\/event\/1032-ecstatic-dance-universe-kareem",
"url_ticketshop": "https:\/\/hipsy.nl\/shop\/1032-ecstatic-dance-universe-kareem",
"qr_ticketshop": "https:\/\/hipsy.nl\/qr\/ticketshop-1032.png",
"tickets": [
{
"id": 83,
"type": "ticket",
"name": "Early Bird",
"description": "",
"price": 17.5,
"status": "sale",
"available": 7,
"sale_start": "2022-03-22T10:07:00.000000Z",
"sale_end": null
},
...
]
},
...
],
"links": {
"first": "https:\/\/api.hipsy.nl\/v1\/organisation\/ecstatic-dance-universe\/events?page=1",
"last": "https:\/\/api.hipsy.nl\/v1\/organisation\/ecstatic-dance-universe\/events?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https:\/\/api.hipsy.nl\/v1\/organisation\/ecstatic-dance-universe\/events?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https:\/\/api.hipsy.nl\/v1\/organisation\/ecstatic-dance-universe\/events",
"per_page": 25,
"to": 1,
"total": 1
}
}