Introduction

Eventzilla API provides an easy way to integrate and extend Eventzilla for your event organizing requirements. It has predictable, resource-oriented URLs, which are organized around the JSON API. All API methods return responses in JSON format. In Version 1, we have started off with the most common scenarios of retreiving data associated with your Eventzilla account. We would love to hear your feedback about the available and also hear from you about what else you would like to see in the API in future releases. So please feel free to drop us a line.
To get started with generating your own application token, use the link below.
Get Started now

To test the API endpoints, use our Swagger endpoint testing tool: [Click here](http://api.eventzilla.net/swagger "Swagger")

Authentication

In order to send a request to the Eventzilla API, you must generate a API token by creating a new application within your account settings section **(Settings > App Management)**. You must authenticate your account when using the API by including your API token in the request. Ensure that your API token is kept a secret and also remember that you can always disable old tokens and create new ones under your Eventzilla account.
Eventzilla API is accessible only secure HTTPS protocol, so ensure that all requests are sent over **HTTPS** only. #### Sample token #### ``` token:565e95b08ad5210001000001bf8fe9787f6f4c674f2fd622844adf23 ```

Filtering

Most of our methods support filtering and you can filter your request by using a field returned by a resource request as a query parameter. A common example would be to filter only live events by using: **/api/event/?status=live** #### API Endpoint #### ``` https://www.eventzillaapi.com/api/v1/events/?status=live ```

Paging

Most of our methods, which return multiple records implement flexible paging in order to make responses faster. Following are the parameters available to use the paging utility with our API methods: #### API Endpoint #### ``` https://www.eventzillaapi.com/api/v1/events?offset=1&limit=2 ``` #### Attributes #### | | | |----------: | ----------| |**PARAM**|**USAGE**|**DEFAULT VALUE**|**DESCRIPTION**| |offset __(integer)__ | ?paging[offset]= |0| Records to offset before returning the specified limit | |limit __(integer)__ | ?paging[limit]= |20| Limit of records per response |

Events

A common example would be to find all the **events** by a particular user. The event object represents any event within the user's Eventzilla account #### API Endpoints #### ``` https://www.eventzillaapi.com/api/v1/events/ ```
#### Attributes #### | | | |----------: | ----------| |id__(integer)__ | Unique Identifier of the event | |title__(string)__ | Title of the event | |description__(string)__ | Full description of the event in escaped HTML | |currency__(string)__ | Currency used for the event | |start_date__(datetime)__ | Start date for the forst occurance of this event | |end_date__(datetime)__ | End date for the forst occurance of this event | |time_zone__(string)__ | Time zone where this event occurs | |tickets_sold__(integer)__ | Number of tickets sold till date | |tickets_total__(integer)__ | Total tickets available for this event | |status__(string)__ | Status of the event (Live / Draft / Unpublished / Completed) | |show_remaining__(bool)__ | Allow Display no of available tickets | |twitter_hashtag__(string)__ | hashtag to include in auto-tweet | |utc_offset__(string)__ | Time span in hours between the event's time zone and UTC time | |invite_code__(string)__ | invite code of this event | |url__(string)__ | Unique address (URL) for the event | |logo_url__(string)__ | Path of your uploaded logo image |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/events/'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { "pagination": [ { "offset": 0, "limit": 20, "total": 20 } ], "events": [ { "id": 0, "title": "string", "description": "string", "currency": "string", "start_date": "2016-02-24T06:36:02.914Z", "start_time": "string", "end_date": "2016-02-24T06:36:02.914Z", "end_time": "string", "time_zone": "string", "tickets_sold": 0, "tickets_total": 0, "status": "string", "show_remaining": true, "twitter_hashtag": "string", "utc_offset": "string", "invite_code": "string", "url": "string", "logo_url": "string" } ] } ```
#### API Endpoints #### ``` https://www.eventzillaapi.com/api/v1/events/{eventid} ```
#### Attributes #### | | | |----------: | ----------| |id__(integer)__ | Unique Identifier of the event | |title__(string)__ | Title of the event | |description__(string)__ | Full description of the event in escaped HTML | |currency__(string)__ | Currency used for the event | |start_date__(datetime)__ | Start date for the forst occurance of this event | |end_date__(datetime)__ | End date for the forst occurance of this event | |time_zone__(string)__ | Time zone where this event occurs | |tickets_sold__(integer)__ | Number of tickets sold till date | |tickets_total__(integer)__ | Total tickets available for this event | |status__(string)__ | Status of the event (Live / Draft / Unpublished / Completed) | |show_remaining__(bool)__ | Allow Display no of available tickets | |twitter_hashtag__(string)__ | hashtag to include in auto-tweet | |utc_offset__(string)__ | Time span in hours between the event's time zone and UTC time | |invite_code__(string)__ | invite code of this event | |url__(string)__ | Unique address (URL) for the event | |logo_url__(string)__ | Path of your uploaded logo image |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/events/{eventid}'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { "events": [ { "id": 0, "title": "string", "description": "string", "currency": "string", "start_date": "2016-02-24T06:36:02.914Z", "start_time": "string", "end_date": "2016-02-24T06:36:02.914Z", "end_time": "string", "time_zone": "string", "tickets_sold": 0, "tickets_total": 0, "status": "string", "show_remaining": true, "twitter_hashtag": "string", "utc_offset": "string", "invite_code": "string", "url": "string", "logo_url": "string" } ] } ```



#### Tickets #### Returns an tickets(**ticket category**) for the specified event. #### API Endpoint #### ``` https://www.eventzillaapi.com/api/v1/events/{eventid}/tickets ```
#### Attributes #### | | | |----------: | ----------| |id __(integer)__ | Unique Identifier for this tickets | |title __(string)__ | title of the ticket category | |quantity_total__(string)__ | total no of ticket quantity | |price__(string)__ | Price of tickets | |description __(string)__ | Full discription of the tickets | |sales_start_date__(string)__ | Sales start date for the tickets| |sales_start_time__(integer)__ | start time | |sales_end_date__(integer)__ | Sales end date for the tickets | |sales_end_time__(string)__ | Sales end time for the tickets | |group_discount__(string)__ | group discouunt of tickets, if applicable | |group_percentage__(string)__ | group percentage of tickets, if applicable | |group_price__(string)__ | group price of tickets, if applicable | |additional_instructions__(string)__ | Full additional description of tickets | |unlock_code__(string)__ | unlock code of specified tickets, if applicable | |ticket_type__(string)__ | ticket category(Paid/Free/Partial/Addons/donation/Approval/) | |isvisible__(bool)__ | Display the ticket category in sale page(Hide/Show) | |boxoffice_only__(string)__ | Allow to boxoffice sale, if applicable | |allow_partial_payment__(string)__ | Allow to partial payment of tickets , if applicable | |limit_minimum__(string)__ | minimum limit of selected quantity | |limit_maximum__(string)__ | maximum limit of selected quantity | |partial_payment_installments__(string)__ | No of installment for the partial payment | |partial_payment_frequency__(string)__ | Frequency of partial payment(Monthly/Weekly) | |partial_payment_amount__(string)__ | Splitted partial payment amount |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/events/{eventid}/tickets'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { { "tickets": [ { "id": 0, "title": "string", "quantity_total": 0, "description": "string", "discount_id": 0, "sales_start_date": "2016-03-11T06:53:22.838Z", "sales_start_time": "string", "sales_end_date": "2016-03-11T06:53:22.838Z", "sales_end_time": "string", "group_discount": 0, "group_percentage": 0, "group_price": 0, "additional_instructions": "string", "unlock_code": "string", "ticket_type": "string", "boxoffice_only": true, "is_visible": true, "allow_partial_payment": true, "limit_minimum": 0, "limit_maximum": 0, "partial_payment_installments": 0, "partial_payment_frequency": "string", "price": 0, "partial_payment_amount": 0 } ] } } ```



Transactions

Get Individual transaction details for spcified event. #### API Endpoint #### ``` https://www.eventzillaapi.com/api/v1/events/{eventid}/transactions ```
#### Attributes #### | | | |----------: | ----------| |refno__(string)__ | Order Reference for this transaction | |id__(integer)__ | Unique Identifier for this transaction | |transaction_date__(string)__ | Timestamp of this transaction | |transaction_amount__(string)__ | Transaction amount | |tickets_in_transaction__(string)__ | Number of tickets / attendees in this transaction | |event_date __(datetime)__ | Event date for which this transaction corressponds to | |transaction_status__(string)__ | Transaction Status (Confirmed/Pending/Cancelled/Incomplete) | |user_id__(integer)__ | Unique Identifier of the buyer for this transaction | |event_id__(integer)__ | Unique Identifier of the event for this transaction | |title__(string)__ | Title of the event for this transaction | |email__(string)__ | Email address of the buyer | |buyer_first_name__(string)__ | First name of the buyer | |buyer_last_name__(string)__ | Last name of the buyer | |promo_code__(string)__ | Discount code used in this transaction, if applicable | |payment_type__(string)__ | Payment method used in this transaction, if applicable |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/events/{eventid}/transactions'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { { "pagination": [ { "offset": 0, "limit": 20, "total": 20 } ], "transactions": [ { "refno": "string", "id": 0, "transaction_date": "2016-02-24T06:36:03.144Z", "transaction_amount": 0, "tickets_in_transaction": 0, "event_date": "2016-02-24T06:36:03.144Z", "transaction_status": "string", "user_id": 0, "event_id": 0, "title": "string", "email": "string", "buyer_first_name": "string", "buyer_last_name": "string", "promo_code": "string", "payment_type": "string" } ] } } ```



Attendees

Get attendees details for specified event. #### API Endpoints #### ``` https://www.eventzillaapi.com/api/v1/events/{eventid}/attendees ```
#### Attributes #### | | | |----------: | ----------| |first_name__(string)__ | First name of this attendee | |last_name__(string)__ | Last name of this attendee | |ticket_type__(string)__ | Ticket / Registration type registered by this attendee | |bar_code__(string)__ | Unique bar code associated with this attendee | |is_attended__(string)__ | Checked-in / attendence status of this attendee | |refno__(string)__ | Order Reference for this transaction | |questionid__(string)__ | Unique identifier of question | |questions__(string)__ | Full question | |answer__(string)__ | Full answer | |id__(string)__ | Unique Identifier for this transaction| |transaction_date__(string)__ | Timestamp of this transaction | |transaction_amount__(string)__ | Transaction amount | |event_date__(string)__ | Event date for which this transaction corressponds to | |user_id__(string)__ | Unique Identifier for this transaction | |event_id__(string)__ | event id | |title__(string)__ | title of the event | |email__(string)__ | Email address of the buyer | |buyer_first_name__(string)__ | First name of the buyer | |buyer_last_name__(string)__ | Last name of the buyer | |payment_type__(string)__ | Payment method used in this transaction, if applicable |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/events/{eventid}/attendees'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { "attendees": [ { "first_name": "string", "last_name": "string", "ticket_type": "string", "bar_code": "string", "is_attended": "string", "questions": [ { "questions": "string", "answer": "string" } ], "refno": "string", "id": 0, "transaction_date": "2016-02-24T06:36:03.042Z", "transaction_amount": 0, "tickets_in_transaction": 0, "event_date": "2016-02-24T06:36:03.042Z", "transaction_status": "string", "user_id": 0, "event_id": 0, "title": "string", "email": "string", "buyer_first_name": "string", "buyer_last_name": "string", "promo_code": "string", "payment_type": "string" } ] } ```

Users

Organizer and sub-organizer response details #### API Endpoints #### ``` https://www.eventzillaapi.com/api/v1/users/ ```
#### Attributes #### | | | |----------: | ----------| |id__(integer)__ | Unique Identifier of the organizer for this account | |username__(string)__ | organizer username | |first_name__(string)__ | first_name of the organizer | |last_name__(string)__ | lastname of the organizer | |company__(string)__ | organizer company name | |address_line1__(string)__ | address line1 of the organizer | |address_line2__(string)__ | address line2 of the organizer | |address_locality__(string)__ | address locality of organizer | |address_region__(string)__ | address region of organizer | |address_country__(string)__ | address country to use for address | |zip_code__(string)__ | zip code | |email__(string)__ | organizer email id | |timezone__(string)__ | Time zone of this organizer | |website__(string)__ | organizer website | |phone_primary__(string)__ | primary phone | |avatar_url__(string)__ | Path of your uploaded avatar image | |facebook_id__(string)__ | Registered facebook URL | |twitter_id__(string)__ | Registered twitter URL | |last_seen__(string)__ | lastupdated of this organizer account | |user_type__(string)__ | Represent the usertype(organizer/sub-organizer) |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/users/'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { "pagination": [ { "offset": 0, "limit": 20, "total": 20 } ], "users": [ { "id": 0, "username": "string", "first_name": "string", "last_name": "string", "company": "string", "address_line1": "string", "address_line2": "string", "zip_code": "string", "address_locality": "string", "address_region": "string", "address_country": "string", "email": "string", "timezone": "string", "website": "string", "phone_primary": "string", "avatar_url": "string", "facebook_id": "string", "twitter_id": "string", "last_seen": "2016-02-24T06:36:03.173Z", "user_type": "string" } ] } ```
#### API Endpoints #### ``` https://www.eventzillaapi.com/api/v1/users/{userid} ```
#### Attributes #### | | | |----------: | ----------| |id__(integer)__ | Unique Identifier of the organizer for this account | |username__(string)__ | organizer username | |first_name__(string)__ | first_name of the organizer | |last_name__(string)__ | lastname of the organizer | |company__(string)__ | organizer company name | |address_line1__(string)__ | address line1 of the organizer | |address_line2__(string)__ | address line2 of the organizer | |address_locality__(string)__ | address locality of organizer | |address_region__(string)__ | address region of organizer | |address_country__(string)__ | address country to use for address | |zip_code__(string)__ | zip code | |email__(string)__ | organizer email id | |timezone__(string)__ | Time zone of this organizer | |website__(string)__ | organizer website | |phone_primary__(string)__ | primary phone | |avatar_url__(string)__ | Path of your uploaded avatar image | |facebook_id__(string)__ | Registered facebook URL | |twitter_id__(string)__ | Registered twitter URL | |last_seen__(string)__ | lastupdated of this organizer account | |user_type__(string)__ | Represent the usertype(organizer/sub-organizer) |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/users/{userid}'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { "users": [ { "id": 0, "username": "string", "first_name": "string", "last_name": "string", "company": "string", "address_line1": "string", "address_line2": "string", "zip_code": "string", "address_locality": "string", "address_region": "string", "address_country": "string", "email": "string", "timezone": "string", "website": "string", "phone_primary": "string", "avatar_url": "string", "facebook_id": "string", "twitter_id": "string", "last_seen": "2016-02-24T06:36:03.173Z", "user_type": "string" } ] } ```

Transactions

Get Individual transaction details for specified transaction id. #### API Endpoints #### ``` https://www.eventzillaapi.com/api/v1/transactions/{transactionid} ```
#### Attributes #### | | | |----------: | ----------| |refno__(string)__ | Order Reference for this transaction | |id__(integer)_ | Unique Identifier for this transaction | |transaction_date__(string)__ | Timestamp of this transaction | |transaction_amount__(string)__ | Transaction amount | |tickets_in_transaction__(string)__ | Number of tickets / attendees in this transaction | |event_date __(datetime)__ | Event date for which this transaction corressponds to | |transaction_status__(string)__ | Transaction Status (Confirmed/Pending/Cancelled/Incomplete) | |buyer_id__(integer)__ | Unique Identifier of the buyer for this transaction | |event_id__(integer)__ | Unique Identifier of the event for this transaction | |title__(string)__ | Title of the event for this transaction | |email__(string)__ | Email address of the buyer | |buyer_first_name__(string)__ | First name of the buyer | |buyer_last_name__(string)__ | Last name of the buyer | |promo_code__(string)__ | Discount code used in this transaction, if applicable | |payment_type__(string)__ | Payment method used in this transaction, if applicable |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/transactions/{transactionid}'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { "transaction": [ { "refno": "string", "id": 0, "transaction_date": "2016-02-24T06:36:03.144Z", "transaction_amount": 0, "tickets_in_transaction": 0, "event_date": "2016-02-24T06:36:03.144Z", "transaction_status": "string", "user_id": 0, "event_id": 0, "title": "string", "email": "string", "buyer_first_name": "string", "buyer_last_name": "string", "promo_code": "string", "payment_type": "string" } ] } ```

Attendees

Get Individual attendees details for specified attendee information. #### API Endpoints #### ``` https://www.eventzillaapi.com/api/v1/attendees/{attendeeid} ```
#### Attributes #### | | | |----------: | ----------| |first_name__(string)__ | First name of this attendee | |last_name__(string)__ | Last name of this attendee | |ticket_type__(string)__ | Ticket / Registration type registered by this attendee | |bar_code__(string)__ | Unique bar code associated with this attendee | |is_attended__(string)__ | Checked-in / attendence status of this attendee | |refno__(string)__ | Order Reference for this transaction | |questionid__(string)__ | Unique identifier of question | |questions__(string)__ | Full question | |answer__(string)__ | Full answer | |id__(string)__ | Unique Identifier for this transaction| |transaction_date__(string)__ | Timestamp of this transaction | |transaction_amount__(string)__ | Transaction amount | |event_date__(string)__ | Event date for which this transaction corressponds to | |user_id__(string)__ | Unique Identifier for this transaction | |event_id__(string)__ | event id | |title__(string)__ | title of the event | |email__(string)__ | Email address of the buyer | |buyer_first_name__(string)__ | First name of the buyer | |buyer_last_name__(string)__ | Last name of the buyer | |payment_type__(string)__ | Payment method used in this transaction, if applicable |

Example Request

curl 'https://www.eventzillaapi.com/api/v1/events/attendees/{attendeeid}'\
-H "token: 5da984f26e412e71dbcccc89a7fa8cebe" \
-X GET
#### Sample Result #### ```json { "attendees": [ { "first_name": "string", "last_name": "string", "ticket_type": "string", "bar_code": "string", "is_attended": "string", "questions": [ { "questioId": 0, "questions": "string", "answer": "string" } ], "refno": "string", "id": 0, "transaction_date": "2016-02-24T06:36:03.042Z", "transaction_amount": 0, "tickets_in_transaction": 0, "event_date": "2016-02-24T06:36:03.042Z", "transaction_status": "string", "user_id": 0, "event_id": 0, "title": "string", "email": "string", "buyer_first_name": "string", "buyer_last_name": "string", "promo_code": "string", "payment_type": "string" } ] } ```