inaturalistjs
    Preparing search index...

    Type Alias GetProjectsData

    type GetProjectsData = {
        body?: never;
        path?: never;
        query?: {
            featured?: true;
            hasParams?: boolean;
            hasPosts?: boolean;
            id?: string[];
            lat?: number;
            lng?: number;
            memberId?: number;
            noteworthy?: true;
            notId?: string[];
            orderBy?: "recent_posts" | "created" | "updated" | "distance" | "featured";
            perPage?: string;
            placeId?: string[];
            q?: string;
            radius?: string;
            ruleDetails?: true;
            siteId?: number;
            type?: "collection" | "umbrella";
        };
        url: "/projects";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: never
    path?: never
    query?: {
        featured?: true;
        hasParams?: boolean;
        hasPosts?: boolean;
        id?: string[];
        lat?: number;
        lng?: number;
        memberId?: number;
        noteworthy?: true;
        notId?: string[];
        orderBy?: "recent_posts" | "created" | "updated" | "distance" | "featured";
        perPage?: string;
        placeId?: string[];
        q?: string;
        radius?: string;
        ruleDetails?: true;
        siteId?: number;
        type?: "collection" | "umbrella";
    }

    Type declaration

    • Optionalfeatured?: true

      Must be marked featured for the relevant site

    • OptionalhasParams?: boolean

      Must have search parameter requirements

    • OptionalhasPosts?: boolean

      Must have posts

    • Optionalid?: string[]

      Must have this ID

    • Optionallat?: number

      Must be within a {radius} kilometer circle around this lat/lng (*lat, *lng, radius)

    • Optionallng?: number

      Must be within a {radius} kilometer circle around this lat/lng (*lat, *lng, radius)

    • OptionalmemberId?: number

      Project must have member with this user ID

    • Optionalnoteworthy?: true

      Must be marked noteworthy for the relevant site

    • OptionalnotId?: string[]

      Must not have this ID

    • OptionalorderBy?: "recent_posts" | "created" | "updated" | "distance" | "featured"

      Sort field

    • OptionalperPage?: string

      Number of results to return in a page. The maximum value is generally 200 unless otherwise noted

    • OptionalplaceId?: string[]

      Must be associated with this place

    • Optionalq?: string

      Search by name (must start with this value) or by ID (exact match).

    • Optionalradius?: string

      Must be within a {radius} kilometer circle around this lat/lng (*lat, *lng, radius). Defaults to 500km

    • OptionalruleDetails?: true

      Return more information about project rules, for example return a full taxon object instead of simply an ID

    • OptionalsiteId?: number

      Site ID that applies to featured and noteworthy. Defaults to the site of the authenticated user, or to the main iNaturalist site https://www.inaturalist.org

    • Optionaltype?: "collection" | "umbrella"

      Projects must be of this type

    url: "/projects"

    Settings

    Member Visibility

    On This Page

    Properties