Events

List all events

1min
List all events in a Brella organization
GET
Request
Path Params
{organizationId}
required
Number
The id of the Brella organization you are trying to retrieve data from
Query Parameters
page[size]
optional
Number
Paginate the response of this endpoint. By default Brella's endpoints do not enforce pagination
page[number]
optional
Number
Retrieve a specific page of results if pagination is enabled using the previous parameter
created_from
optional
String
Retrieve entries created from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
created_to
optional
String
Retrieve entries created until this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
updated_from
optional
String
Retrieve entries updated from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
updated_to
optional
String
Retrieve entries updated until this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
start_from
optional
String
Retrieve entries (events) starting from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
start_to
optional
String
Retrieve entries (events) starting until this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
end_from
optional
String
Retrieve entries (events) ending from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
end_to
optional
String
Retrieve entries (events) ending from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
Header Parameters
Brella-API-Access-Token
required
String
Your unique Brella API key
Accept
required
String
application/vnd.brella.v4+json
Content-Type
required
String
application/json
Curl
Responses
200


Notes:

  • This endpoint accepts the following URL parameters for filtering:
    • start_from
    • start_to
    • end_from
    • end_to
    • created_from
    • updated_from
    • created_to
    • updated_to
  • Please supply the date in the following format: 2023-11-20T00:00:00.000Z