POST
/
v2
/
get
/
events

Authorizations

Authorization
string
headerrequired

It is the "access_token" returned after login

Body

application/json
categories
enum<string>[]

It is a filter. By default, you get all the event categories.

Available options:
atelier,
brocante,
cinema,
conference,
enfants,
expo,
festival,
gastronomie,
livres,
loisirs,
meeting,
musique,
nature,
pro,
salon,
sciences,
soiree,
solidarite,
spectacle,
sport,
visite,
none
sources
string[]

It is a filter. By default, you get all sources. Check the back office for possible values.

locationFilter
object

You can define a location filter corresponding to a circle or a rectangle.

datesFilter
object
pricesFilter
object
limit
number
Required range: 1 < x < 500
pageNumber
number
orderBy
enum<string>

You can order the events you get by dates or by prices or by distance to a place definied with 'orderByDistance' or by last update dates to update your records. By default it's by ascendant endDates.

Available options:
startDate,
endDate,
updatedAt,
lowestPrice,
highestPrice,
distance
orderByDistance
object

You can define the coordinates of a place to order events according to their distance from that place.

getCommentaries
boolean

Set it to true if you want to retrieve commentaries on events you get. Warning, this reduces the performance of the request, so only use it if you want to use this data.

getPerformers
boolean

Set it to true if you want to retrieve performers on events you get. Warning, this reduces the performance of the request, so only use it if you want to use this data.

Response

201 - application/json
data
object[]
pagination
object