Sanity Library Reference Docs
    Preparing search index...

    Type Alias Organizations<IncludeMembers, IncludeFeatures>

    Organizations: (
        Pick<
            OrganizationBase,
            | "id"
            | "name"
            | "slug"
            | "createdAt"
            | "updatedAt"
            | "defaultRoleName"
            | "dashboardStatus"
            | "aiFeaturesStatus",
        > & (
            boolean extends IncludeMembers
                ? { members?: OrganizationMember[] }
                : IncludeMembers extends true
                    ? { members: OrganizationMember[] }
                    : unknown
        ) & (
            boolean extends IncludeFeatures
                ? { features?: string[] }
                : IncludeFeatures extends true ? { features: string[] } : unknown
        )
    )[]

    The list shape returned from /organizations, with members and/or features conditionally included based on the query options used.

    Type Parameters

    • IncludeMembers extends boolean = false
    • IncludeFeatures extends boolean = false