Skip to content

list_query_params

ListQueryParams

Bases: TypedDict

Interface of the query parameters for listing resources.

Attributes:

Name Type Description
limit NotRequired[int]

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. This value should be taken from a ListResponse object's next_cursor parameter.
select NotRequired[str]

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.
Source code in nylas/models/list_query_params.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
class ListQueryParams(TypedDict):
    """
    Interface of the query parameters for listing resources.

    Attributes:
        limit: The maximum number of objects to return.
            This field defaults to 50. The maximum allowed value is 200.
        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.
        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]
    page_token: NotRequired[str]
    select: NotRequired[str]