Skip to main content
GET
Get events report

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:200

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

dateTimeBegin[before]
string
dateTimeBegin[strictly_before]
string
dateTimeBegin[after]
string
dateTimeBegin[strictly_after]
string
dateTimeEnd[before]
string
dateTimeEnd[strictly_before]
string
dateTimeEnd[after]
string
dateTimeEnd[strictly_after]
string
name
string
type
string
type[]
string[]
unit
string
unit[]
string[]
owner
string
owner[]
string[]
isAnnualReport
boolean
isAnnualReport[]
boolean[]
sdg
string
product
string
product[]
string[]
tenant
string
tenant[]
string[]
customStatus
string
customStatus[]
string[]
parentEvent
string
parentEvent[]
string[]
order[dateTimeBegin]
enum<string>
default:asc
Available options:
asc,
desc
order[name]
enum<string>
default:asc
Available options:
asc,
desc
order[type.name]
enum<string>
default:asc
Available options:
asc,
desc
order[unit.name]
enum<string>
default:asc
Available options:
asc,
desc
order[location]
enum<string>
default:asc
Available options:
asc,
desc
exists[unit]
boolean

Response

200 - application/json

Event collection

id
integer
read-only
uuid
string | null
read-only
name
string
location
string | null
description
string | null
logo
string | null
meetExists
boolean
read-only
owner
object | null
type
object | null
unit
object | null
dateCreated
string<date-time>
read-only
tags
string | null
goal
string | null
target
string | null
activities
string | null
advertising
string | null
budget
string | null
partners
string | null
numberOfParticipants
integer | null
isGeneralMeeting
boolean | null
isGeneralMeetingEx
boolean | null
isGeneralMeetingElection
boolean | null
isTraining
boolean | null
eventMedia
object[]
parentEvent
unknown
position
integer | null
logoFromAlbum
string | null
dateTimeBegin
string<date-time> | null
dateTimeEnd
string<date-time> | null
isAnnualReport
boolean | null
product
object | null
meet
string | null
settings
(string | null)[] | null
hasVoting
boolean | null
sdg
(string | null)[] | null
isPublic
boolean | null
hasEventTicketing
boolean | null
default:false
timezone
string | null
isPast
boolean
read-only
status
string | null
default:draft
newsletterEnabled
boolean | null
placesApiId
string | null
slugGo
string | null
placeLatitude
number | null
placeLongitude
number | null
gamificationPoints
integer | null
badge
object | null
customStatus
object | null
sendAttendanceReminder
boolean | null
sendOneHourReminder
boolean | null
invitesSent
boolean | null
requiresRegistrationForm
boolean | null
default:false
maxCapacity
integer | null
registrationManuallyClosed
boolean
default:false
registrationFormText
string | null
Maximum string length: 2000
allowedUserType
object | null