BEbenchling
Box Schema

Get BoxSchema by ID

Get a single BoxSchema by ID.

get/api/v3/box-schema/{box_schema_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

box_schema_idstring required

ID of the BoxSchema.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable
descriptionstring

A description of the schema.

fieldDefinitionsstring uri
heightinteger nullable
idstring
modifiedAtstring datetime nullable
namestring
prefixstring nullable
systemNamestring

A unique, stable identifier for this schema used for programmatic access and integrations.

typestring nullable
widthinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.