@archastro/sdk
    Preparing search index...

    Class TeamCustomObjectResource

    Index

    Constructors

    constructor

    Methods

    create list

    Constructors

    Methods

    • Create a team custom object Creates a new custom object owned by the specified team. The object is instantiated against the schema identified by type (the schema's lookup_key). All field values are validated against that schema's field definitions before the object is persisted. The authenticated user must be a member of the team with sufficient access. If the team is not found or the caller lacks access, the endpoint returns 404. If type does not match a registered schema for the team's organization, the endpoint also returns 404.

      Parameters

      • team: string

        Team ID (team_...). Scopes results to objects owned by this team.

      • input: { fields: Record<string, unknown>; type: string }

        Request body.

        • fields: Record<string, unknown>

          Map of field values to set on the new object. Keys and value types must conform to the schema identified by type.

        • type: string

          Schema type identifier (lookup_key) that defines the object's fields and validation rules.

      Returns Promise<CustomObject>

      The newly created custom object.

    • List a team's custom objects Returns a paginated list of custom objects owned by the specified team, filtered to a single schema type. Results are ordered by creation time descending unless query is provided, in which case they are ordered by full-text relevance score descending. Use limit and offset for page-based pagination. Use row_key or sort_key to narrow results to objects matching those index values. Full-text search via query operates only against the fields configured as search_fields on the schema. The authenticated user must be a member of the team with sufficient access. Returns 404 if the team is not found, the caller lacks access, or type does not match a registered schema for the team's organization.

      Parameters

      • team: string

        Team ID (team_...). Scopes results to objects owned by this team.

      • Optionalparams: {
            limit?: number;
            offset?: number;
            query?: string;
            rowKey?: string;
            sortKey?: string;
            type?: string;
        }

        Query parameters.

        • Optionallimit?: number

          Maximum number of objects to return per page.

        • Optionaloffset?: number

          Number of objects to skip before returning results. Use with limit for page-based pagination.

        • Optionalquery?: string

          Full-text search string matched against the schema's configured search_fields. When provided, results are ordered by relevance score descending instead of creation time descending.

        • OptionalrowKey?: string

          Filter results to objects whose row_key exactly matches this value.

        • OptionalsortKey?: string

          Filter results to objects whose sort_key exactly matches this value.

        • Optionaltype?: string

          Schema type identifier (lookup_key) that filters results to objects of this schema.

      Returns Promise<
          {
              data: {
                  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;
              }[];
              meta?: Record<string, unknown>;
          },
      >

      Successful response

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods