nylas
    Preparing search index...

    Interface ListGrantsQueryParams

    Interface representing the query parameters for listing grants.

    interface ListGrantsQueryParams {
        before?: number;
        email?: string;
        grant_status?: string;
        ip?: string;
        limit?: number;
        offset?: number;
        order_by?: "desc" | "asc";
        provider?: Provider;
        since?: number;
        sort_by?: "created_at" | "updated_at";
    }
    Index

    Properties

    before? email? grant_status? ip? limit? offset? order_by? provider? since? sort_by?

    Properties

    before?: number

    Scope grants to a specific point in time by Unix timestamp.

    email?: string

    Filtering your query based on grant email address (if applicable)

    grant_status?: string

    Filtering your query based on grant email status (if applicable)

    ip?: string

    Filtering your query based on grant IP address

    limit?: number

    The maximum number of objects to return. This field defaults to 10. The maximum allowed value is 200.

    offset?: number

    Offset grant results by this number.

    order_by?: "desc" | "asc"

    Specify ascending or descending order.

    provider?: Provider

    Filtering your query based on OAuth provider

    since?: number

    Scope grants from a specific point in time by Unix timestamp.

    sort_by?: "created_at" | "updated_at"

    Sort entries by field name

    Settings

    Member Visibility

    On This Page

    Properties