List events - Bevy API GDG

Retrieves a list of event records.

{ "count": 1, "links": { "previous": null, "next": null }, "pagination": { "current_page": 1, "next_page": 2, "page_size": 500, "previous_page": null }, "results": [ { "allows_cohosting": false, "checkin_count": 0, "cohost_registration_url": "https://instance.bevy.com/events/details/chapter-2024-presents/", "end_date": "2024-01-09T17:59:22Z", "id": 1234, "start_date": "2024-01-09T17:59:22Z", "status": "Draft", "title": "Chapter 2024", "total_attendees": 0, "total_revenue": 0, "total_tickets_sold": false, "url": "https://instance.bevy.com/events/details/chapter-2024-presents/" } ] }

Request

Query Params

start_date

string

optional

Filters the list to only include events after the specified date.
Must be used together with end_date.
Format YYYY-MM-DD

end_date

string

optional

Filters the list to only include events before the specified date.
Must be used together with start_date.
Format YYYY-MM-DD

event_type_id

integer

optional

Filters the list to only include events of the specified type.

event_type

string

optional

Filters the list to only include events of the specified event type slug.

chapter

integer

optional

Filters the list to only include events for the specified chapter.

status

string

optional

Filters the list of events by status. The values in this filter contain additional ones to the strict 'status' values of the events, check the notes for each filter value.
Possible values:

Draft
Pending
Published
Live
Canceled
Completed

fields

string

optional

Allows specifying what fields to return for each event.
Can use any of the fields listed in the event details endpoint separated by commas.

order_by

string

optional

Sort the results by this value. Possible values id, title, chapter_id, end_date.
Prefix value with '-' to specify descending order.

page_size

integer

optional

The number of records to return per page. Default is 500. Maximum is 500.

allow_cohosting

boolean

optional

Use to filter for events that have cohosting enabled.

Responses

🟢200OK

application/json

successful operation

Body

count

number

optional

Example:

links

object (Links)

optional

string | null

required

Example:

null

string | null

required

Example:

null

pagination

object (Pagination)

optional

current_page

number

required

Example:

next_page

number | null

required

Example:

page_size

number

required

Example:

500

previous_page

number | null

required

Example:

null

results

array[object (EventSummary) {12}]

optional

allows_cohosting

boolean

optional

Example:

false

checkin_count

number

optional

Example:

cohost_registration_url

string

optional

Example:

https://instance.bevy.com/events/details/chapter-2024-presents/

end_date

string | null

optional

Example:

2024-01-09T17:59:22Z

integer

optional

Example:

1234

start_date

string | null

optional

Example:

2024-01-09T17:59:22Z

status

string

optional

Example:

Draft

title

string | null

optional

Example:

Chapter 2024

total_attendees

number

optional

Example:

total_revenue

number | null

optional

Example:

total_tickets_sold

boolean

optional

Example:

false

url

string

optional

Example:

https://instance.bevy.com/events/details/chapter-2024-presents/

🟠403Forbidden