Skip Main Navigation
Page Content

Venues

GET /venues/:id/

Returns a venue object.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /venues/:id/

Updates a venue and returns it as an object.

Parameters

Name Type Required Description
venue.name string No The name of the venue
venue.organizer_id string No The organizer this venue belongs to (optional - leave this off to use the default organizer)
venue.address.address_1 string No The first line of the address
venue.address.address_2 string No The second line of the address
venue.address.city string No The city where the venue is
venue.address.region string No The region where the venue is
venue.address.postal_code string No The postal_code where the venue is
venue.address.country string No The country where the venue is
venue.address.latitude decimal No The latitude of the coordinates for the venue
venue.address.longitude decimal No The longitude of the coordinates for the venue

Errors

No endpoint-specific errors

POST /venues/

Creates a new venue with associated address.

Parameters

Name Type Required Description
venue.name string Yes The name of the venue
venue.organizer_id string No The organizer this venue belongs to (optional - leave this off to use the default organizer)
venue.address.address_1 string No The first line of the address
venue.address.address_2 string No The second line of the address
venue.address.city string No The city where the venue is
venue.address.region string No The region where the venue is
venue.address.postal_code string No The postal_code where the venue is
venue.address.country string No The country where the venue is
venue.address.latitude decimal No The latitude of the coordinates for the venue
venue.address.longitude decimal No The longitude of the coordinates for the venue

Errors

No endpoint-specific errors

GET /venues/:id/events/

Returns events of a given venue.

Parameters

Name Type Required Description
status string No Only return events with a specific status set. This should be a comma delimited string of status. Valid status: all, draft, live, canceled, started, ended.
order_by string No How to order the results (Valid choices are: start_asc, start_desc, created_asc, or created_desc)
start_date.range_start local datetime No Only return events with start dates after the given date.
start_date.range_end local datetime No Only return events with start dates before the given date.
only_public boolean No Only show public events even if viewing your own events.

Errors

No endpoint-specific errors