@archastro/sdk
    Preparing search index...

    Interface CustomObject

    A custom object belonging to an organization. Custom objects store arbitrary structured data defined by a schema type and are scoped to an org, team, or user.

    interface CustomObject {
        created_at?: string;
        fields?: Record<string, unknown>;
        id: string;
        org?: string;
        row_key?: string;
        sandbox?: string;
        schema_type?: string;
        team?: string;
        updated_at?: string;
        user?: string;
        version?: number;
    }
    Index

    Properties

    created_at? fields? id org? row_key? sandbox? schema_type? team? updated_at? user? version?

    Properties

    created_at?: string

    When the custom object was created (ISO 8601).

    fields?: Record<string, unknown>

    Map of field names to their current values as defined by the object's schema type.

    id: string

    Unique identifier for the custom object (cobj_...).

    org?: string

    ID of the organization this object belongs to (org_...).

    row_key?: string

    An optional stable key used to identify this object by a caller-controlled string rather than its generated ID. null if not set.

    sandbox?: string

    ID of the sandbox environment this object is scoped to (dsb_...). null for production objects.

    schema_type?: string

    The lookup key of the schema type that defines this object's field structure. null if the schema type has not been set.

    team?: string

    ID of the team that owns this object (tem_...). null if the object is not team-scoped.

    updated_at?: string

    When the custom object was last modified (ISO 8601). null if the object has never been updated after creation.

    user?: string

    ID of the user that owns this object (usr_...). null if the object is not user-scoped.

    version?: number

    Optimistic concurrency version of the object. Increments with each successful update; pass this value in write operations to detect conflicting changes.

    Settings

    Member Visibility

    On This Page

    Properties