Ticketum | API

API

Your unique API Key is: Please login to get your API Key

API Calls

Get Events
Get Event
Get Attendees

Get Events

Returns a list of all your registered events

Endpoint:

https://upf.ticketerum.com/api/v1/get_events

Method:

GET

Parameters:

Name	Value	Required	Summary
key	string	yes	Your unique API key

Sample Request:

https://upf.ticketerum.com/api/v1/get_events?key=<< Please login to get your API Key >>

Sample Response:

{
    "events": [
        {
            "id": << event_id >>,
            "name": << event_name >>,
            "url": << event_url >>,
            
            "detall": << event_details >>
        },
        ...
    ]
}

Get Event

Returns a the details of an event

Endpoint:

https://upf.ticketerum.com/api/v1/get_event

Method:

GET

Parameters:

Name	Value	Required	Summary
key	string	yes	Your unique API key
event_id	string	yes	Your unique ID of the event

Sample Request:

https://upf.ticketerum.com/api/v1/get_event?key=<< Please login to get your API Key >>&event_id=<< event_id >>

Sample Response:

{
    "id": << event_id >>,
    "name": << event_name >>,
    "start": << event_start_date >>,
    "finish": << event_finish_date >>,
    "inscripcion_start": << event_inscripcion_start >>,
    "inscripcion_finish": << event_inscripcion_finish >>,
    "amout_sold": << amount_sold >>,
    "url": << event_url >>,
    "tickets": {
        << ticket_name >>: {
            "sold": << quantity_sold >>,
            "total": << total_quantity >>
        },
        ...
    }
}

Get Attendees

Returns a list of all the registrations to a event

Endpoint:

https://upf.ticketerum.com/api/v1/get_event/attendees

Method:

GET

Parameters:

Name	Value	Required	Summary
key	string	yes	Your unique API key
event_id	string	yes	Your unique ID of the event

Sample Request:

https://upf.ticketerum.com/api/v1/get_event/attendees?key=<< Please login to get your API Key >>&event_id=<< event_id >>

Sample Response:

[
    {
        "order": << order_id >>,
        "inscrito":
            {
                "name": << name >>,
                "surname": << surname >>,
                "email": << email >>,
            }
        
    },
    ...
]