Skip to navigation
Benchling APIBox Schema

List SchemaFieldDefinition items

Beta
List SchemaFieldDefinition items.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

box_schema_idstringRequired
ID of the BoxSchema.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Query parameters

archived.anyOfbooleanOptional

If true, returns archived items. If false, returns unarchived items. If both true and false, returns archived and unarchived items. Comma-separated list.

Response

OK
itemslist of objectsOptional

Errors

400
Box Schema Field Definitions List Request Bad Request Error
403
Box Schema Field Definitions List Request Forbidden Error
404
Box Schema Field Definitions List Request Not Found Error
429
Box Schema Field Definitions List Request Too Many Requests Error
500
Box Schema Field Definitions List Request Internal Server Error