Skip to content

Clarify list-events query param documentation #460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pengfeiye merged 1 commit into from
Apr 3, 2026
+9 −8
Merged

Clarify list-events query param documentation #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Unreleased
* UAS multi-credential update
* Added `specific_time_availability` field to `AvailabilityParticipant` for overriding open hours on specific dates
* Added `smtp_required` option to hosted authentication config to require users to enter SMTP settings during IMAP authentication
* Clarified `ListEventQueryParams` documentation (attribute order, field descriptions, and `expand_recurring` wording)

v6.14.2
----------
Expand Down
16 changes: 8 additions & 8 deletions nylas/models/events.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -818,21 +818,21 @@ class ListEventQueryParams(ListQueryParams):
expand_recurring: If true, the response will include an event for each occurrence of a recurring event within
the requested time range.
If false, only a single primary event will be returned for each recurring event.
Cannot be used when filtering on metadata. Defaults to false.
Cannot be used when filtering on metadata.
busy: Returns events with a busy status of true.
order_by: Order results by the specified field.
Currently only start is supported.
event_type (NotRequired[List[EventType]]): (Google only) Filter events by event type.
event_type: (Google only) Filter events by event type.
You can pass the query parameter multiple times to select or exclude multiple event types.
master_event_id (NotRequired[str]): Filter for instances of recurring events with the
specified master_event_id. Not respected by metadata filtering.
tentative_as_busy: When set to false, treats tentative calendar events as busy:false.
Only applicable for Microsoft and EWS calendar providers. Defaults to true.
master_event_id: Filter for instances of recurring events with the given
master event ID. Not respected by metadata filtering.
select: Comma-separated list of fields to return in the response.
This allows you to receive only the portion of object data that you're interested in.
limit (NotRequired[int]): The maximum number of objects to return.
tentative_as_busy: When set to false, treats tentative calendar events as busy:false.
Only applicable for Microsoft and EWS calendar providers. Defaults to true.
limit: The maximum number of objects to return.
This field defaults to 50. The maximum allowed value is 200.
page_token (NotRequired[str]): An identifier that specifies which page of data to return.
page_token: An identifier that specifies which page of data to return.
This value should be taken from a ListResponse object's next_cursor parameter.
"""

Expand Down
Loading