Sanity Library Reference Docs
    Preparing search index...

    Interface InstallationBase

    The always-present fields of an active singleton installation returned by the Installations API (/installations), before any InstallationInclude.

    https://www.sanity.io/docs/http-reference/applications-api

    interface InstallationBase {
        application: {
            icon: string | null;
            name: string;
            organizationId: string;
            reference: string;
            slug: string | null;
            title: string;
        };
        applicationId: string;
        createdAt: string;
        id: string;
        installedBy: string
        | null;
        organizationId: string;
        updatedAt: string;
    }
    Index

    Properties

    application applicationId createdAt id installedBy organizationId updatedAt

    Properties

    application: {
        icon: string | null;
        name: string;
        organizationId: string;
        reference: string;
        slug: string | null;
        title: string;
    }

    Type declaration

    • icon: string | null

      Sanitized SVG icon markup, or null when the singleton has no icon.

    • name: string

      Stable, immutable identity of the installed singleton, distinct from slug.

    • organizationId: string

      The singleton's publishing organization; the top-level organizationId is the installing one.

    • reference: string

      Qualified, globally-unique handle of the installed singleton (e.g. sanity/<name>).

    • slug: string | null
    • title: string
    applicationId: string
    createdAt: string
    id: string
    installedBy: string | null
    organizationId: string
    updatedAt: string

    Settings

    Member Visibility

    On This Page

    Properties