Events

get
Authorizations
AuthorizationstringRequired
Query parameters
orderingstringOptional

Which field to use when ordering the results.

sourcestring · enumOptional

source

Possible values:
archivedstringOptional

archived

searchstringOptional

A search term.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uri · nullableOptional
previousstring · uri · nullableOptional
get
/events/
200Success
post
Authorizations
AuthorizationstringRequired
Body
sourcestring · enumRead-onlyOptionalPossible values:
external_idstringOptional
event_datestring · date-time · nullableOptional
Responses
post
/events/
201Success
get
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
sourcestring · enumRead-onlyOptionalPossible values:
external_idstring · min: 1Read-onlyOptional
event_datestring · date-time · nullableRead-onlyOptional
tagsstringRead-onlyOptional
createdstring · date-timeRead-onlyOptional
modifiedstring · date-timeRead-onlyOptional
archivedstring · date-time · nullableRead-onlyOptional
get
/events/{id}/
200Success
put
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Body
sourcestring · enumRead-onlyOptionalPossible values:
external_idstringOptional
event_datestring · date-time · nullableOptional
Responses
chevron-right
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
sourcestring · enumRead-onlyOptionalPossible values:
external_idstring · min: 1Read-onlyOptional
event_datestring · date-time · nullableRead-onlyOptional
tagsstringRead-onlyOptional
createdstring · date-timeRead-onlyOptional
modifiedstring · date-timeRead-onlyOptional
archivedstring · date-time · nullableRead-onlyOptional
put
/events/{id}/
200Success
delete
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/events/{id}/
204Success

No content

patch
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Body
sourcestring · enumRead-onlyOptionalPossible values:
external_idstringOptional
event_datestring · date-time · nullableOptional
Responses
chevron-right
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
sourcestring · enumRead-onlyOptionalPossible values:
external_idstring · min: 1Read-onlyOptional
event_datestring · date-time · nullableRead-onlyOptional
tagsstringRead-onlyOptional
createdstring · date-timeRead-onlyOptional
modifiedstring · date-timeRead-onlyOptional
archivedstring · date-time · nullableRead-onlyOptional
patch
/events/{id}/
200Success

Last updated