API referenceBatches

Get batch information

Retrieve information about a batch.

Path parameters

batch_idintegerRequired
The batch ID.

Headers

AuthorizationstringRequired

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

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Response

Batch successfully retrieved.
idinteger
The batch ID.
namestring
The batch name.
workspacestring or null
The name of the workspace in which the batch exists.
mount_pointstring or null
The name of the connected drive in which the batch is stored.
repo_ownerstring or null

The owner of the workspace (also known as the repo) in which the batch exists.

batch_ownerstring or null
Username of the user that created the batch.
created_at_mslong or null
When the batch was created, in Unix time milliseconds.
updated_at_mslong or null
When the batch was last updated, in Unix time milliseconds.
path_suffixstring or null
Batch path suffix from the mount point.