Class ProjectsClient

Client for managing Sanity projects. Provides methods for fetching project information and managing project settings.

Example

// Get current project info
const project = await client.projects.getById('myproject')

// List all projects user has access to
const projects = await client.projects.list()

Constructors

constructor

Methods

getById list

Constructors

constructor

Methods

getById

  • getById(projectId: string): Promise<SanityProject>

    Fetch a project by project ID

    Parameters

    • projectId: string

      ID of the project to fetch

    Returns Promise<SanityProject>

list

  • list(options?: { includeMembers?: true }): Promise<SanityProject[]>

    Fetch a list of projects the authenticated user has access to.

    Parameters

    • Optionaloptions: { includeMembers?: true }

      Options for the list request

      • OptionalincludeMembers?: true

        Whether to include members in the response (default: true)

    Returns Promise<SanityProject[]>

  • list(
        options?: { includeMembers?: false },
    ): Promise<Omit<SanityProject, "members">[]>

    Fetch a list of projects the authenticated user has access to.

    Parameters

    • Optionaloptions: { includeMembers?: false }

      Options for the list request

      • OptionalincludeMembers?: false

        Whether to include members in the response (default: true)

    Returns Promise<Omit<SanityProject, "members">[]>

Settings

Member Visibility

On This Page

Constructors
Methods