v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Calendar Entries

Return the data for all CalendarEntries

Outlines the parameters, optional and required, used when requesting the data for all CalendarEntries

get/calendar_entries.json

Query parameters

calendar_idinteger

The unique identifier for a single Calendar. The keyword null is not valid for this field. The list will be filtered to include only the CalendarEntry records with the matching property.

created_sincestring date-time

Filter CalendarEntry records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

expandedboolean

Returns a record for each occurrence of a recurring calendar event. Non-recurring calendar events are unaffected and returned as separate records regardless of the expanded setting.

external_property_namestring

Filter records to only those with the given external property(s) name set.

e.g. ?external_property_name=Name

external_property_valuestring

Filter records to only those with the given external property(s) value set. Requires external property name as well.

e.g. ?external_property_name=Name&external_property_value=Value

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

fromstring date-time

Filter CalendarEntry records to those that end on or after the provided time (Expects an ISO-8601 timestamp).

has_court_ruleboolean

Allows matching court rule on calendar entry.

ids[]integer

Filter CalendarEntry records to those having the specified unique identifiers.

is_all_dayboolean

Filter CalendarEntry records to those that are marked as all day events.

limitinteger

A limit on the number of CalendarEntry records to be returned. Limit can range between 1 and 200. Default: 200.

matter_idinteger

The unique identifier for a single Matter. Use the keyword null to match those without a CalendarEntry. The list will be filtered to include only the CalendarEntry records with the matching property.

owner_entries_across_all_usersboolean

Returns CalendarEntry records for all users related to a matter. Requires matter id.

page_tokenstring

A token specifying which page to return.

querystring

Allows matching search on calendar entry.

source'web' | 'mobile'

Filter CalendarEntry records to those having a specific calendar visibility source (mobile, web).

tostring date-time

Filter CalendarEntry records to those that begin on or before the provided time (Expects an ISO-8601 timestamp).

updated_sincestring date-time

Filter CalendarEntry records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

visibleboolean

Filter CalendarEntry records to those that are visible.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok