List orders

With this API you can list all orders of ticket purchases of an selected organisation.

Request

Make a GET request to the following endpoint with the API Key.

https://api.hipsy.nl/v1/organisation/{organisation-slug}/orders

In the URL the organsation-slug should be passed to select an organisation. 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.

{info} Be aware that if you change the slug of the organisation, 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 value
event optional ID of an event to filter only orders of the given event.
limit optional Can return up to 100 orders 25
page optional Page selection in case there are more results than the given limit. 1

Response

An array will be returned with all available organisations.

Key Description
id The ID of the order
event_id The ID of the event
event_name The name of the event
revenue The revenue of the order which will be paid out to the organisation. This is exclusive service costs.
first_name First name of the buyer
last_name Last name of the buyer
locale Used language when buying the ticket. Can be either nl, en or de
newsletter 1 or 0. Returns 1 if ther buyer has subscribed to your newsletter
date Date of the order

Example

{
    "data": [
        {
            "id": 1148,
            "event_id": 1030,
            "event_name": "Ecstatic Dance Universe - Kareem",
            "revenue": "17.50",
            "first_name": "Jochem",
            "last_name": "Gruter",
            "email": "info@hipsy.nl",
            "locale": "nl",
            "newsletter": 0,
            "date": "2022-12-16T15:04:51.000000Z"
        },
        ...
    ],
    "links": {
        "first": "https:\/\/api.hipsy.nl\/1.0\/organisation\/ecstatic-dance-universe\/orders?page=1",
        "last": "https:\/\/api.hipsy.nl\/1.0\/organisation\/ecstatic-dance-universe\/orders?page=41",
        "prev": null,
        "next": "https:\/\/api.hipsy.nl\/1.0\/organisation\/ecstatic-dance-universe\/orders?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 3,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https:\/\/api.hipsy.nl\/1.0\/organisation\/ecstatic-dance-universe\/orders?page=1",
                "label": "1",
                "active": true
            },
            ...
        ],
        "path": "https:\/\/api.hipsy.nl\/1.0\/organisation\/ecstatic-dance-universe\/orders",
        "per_page": 25,
        "to": 25,
        "total": 81
    }
}