@webitel/api-services
    Preparing search index...

    Type Alias ListEmailsParams

    Generated by orval v8.5.3 🍺 Do not edit manually. Webitel API OpenAPI spec version: 24.04.0

    type ListEmailsParams = {
        fields?: string[];
        id?: string[];
        page?: number;
        primary?: boolean;
        q?: string;
        size?: number;
        sort?: string[];
        typeId?: string;
        typeName?: string;
        typeType?: string;
        verified?: boolean;
    }
    Index

    Properties

    fields? id? page? primary? q? size? sort? typeId? typeName? typeType? verified?

    Properties

    fields?: string[]

    Fields to be retrieved into result.

    id?: string[]

    Link(s) with unique ID only.

    Optionalpage

    page?: number

    Page number of result dataset records. offset = (page*size)

    primary?: boolean

    Primary email address only.

    q?: string

    Search term: email address. ? - matches any one character * - matches 0 or more characters

    size?: number

    Size count of records on result page. limit = (size++)

    sort?: string[]

    Sort the result according to fields.

    typeId?: string

    Reference Object unique ID.

    typeName?: string

    Reference Object display name.

    typeType?: string

    Reference Object well-known type.

    verified?: boolean

    Verified email addresses only.

    Settings

    Member Visibility

    On This Page

    Properties