nylas
    Preparing search index...

    Interface Workspace

    Interface representing a Nylas workspace.

    A workspace groups grants in a Nylas application by email domain. Grants can be auto-grouped (by matching email domain) or manually assigned and removed.

    interface Workspace {
        applicationId: string;
        autoGroup: boolean;
        createdAt: number;
        default?: boolean;
        domain: string;
        name: string;
        policyId?: string;
        ruleIds?: string[];
        updatedAt: number;
        workspaceId: string;
    }
    Index

    Properties

    applicationId autoGroup createdAt default? domain name policyId? ruleIds? updatedAt workspaceId

    Properties

    applicationId: string

    The ID of the application that owns the workspace. Set server-side from the API key, never from the request body.

    autoGroup: boolean

    When true, new grants whose email domain matches domain are auto-assigned.

    createdAt: number

    Unix timestamp (seconds) when the workspace was created.

    default?: boolean

    When true, this is the application's default workspace.

    domain: string

    Top-level email domain for the workspace. May be an empty string when created with autoGroup false and no domain.

    name: string

    Descriptive name for the workspace.

    policyId?: string

    The ID of the inbox policy attached to the workspace.

    ruleIds?: string[]

    The IDs of the inbox rules attached to the workspace.

    updatedAt: number

    Unix timestamp (seconds) when the workspace was last updated.

    workspaceId: string

    Globally unique identifier for the workspace.

    Settings

    Member Visibility

    On This Page

    Properties