inaturalistjs
    Preparing search index...

    Type Alias GetMessagesData

    type GetMessagesData = {
        body?: never;
        path?: never;
        query?: {
            box?: "inbox" | "sent" | "any";
            page?: string;
            q?: string;
            threads?: boolean;
            userId?: string;
        };
        url: "/messages";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: never
    path?: never
    query?: {
        box?: "inbox" | "sent" | "any";
        page?: string;
        q?: string;
        threads?: boolean;
        userId?: string;
    }

    Type declaration

    • Optionalbox?: "inbox" | "sent" | "any"

      Whether to view messages the user has received (default) or messages the user has sent

    • Optionalpage?: string

      Pagination page number

    • Optionalq?: string

      Search query for subject and body

    • Optionalthreads?: boolean

      Groups results by thread_id, only shows the latest message per thread, and includes a thread_messages_count attribute showing the total number of messages in that thread. Note that this will not work with the q param, and it probably should only be used with box=any because the thread_messages_count will be inaccurate when you restrict it to inbox or sent.

    • OptionaluserId?: string

      User ID or username of correspondent to filter by

    url: "/messages"

    Settings

    Member Visibility

    On This Page

    Properties