Get batch information

Retrieve information about a batch.

AuthorizationBearer

Bearer HTTP authentication.

batch_idintegerRequired

The batch ID.

Batch successfully retrieved.

idinteger

The batch ID.

namestring

The batch name.

workspacestring

The name of the workspace in which the batch exists.

mount_pointstring

The name of the connected drive in which the batch is stored.

repo_ownerstring

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

batch_ownerstring

Username of the user that created the batch.

created_at_mslong

When the batch was created, in Unix time milliseconds.

updated_at_mslong

When the batch was last updated, in Unix time milliseconds.

path_suffixstring

Batch path suffix from the mount point.

404

Not Found Error

1	{
2	"id": 98765,
3	"name": "Invoice Processing Batch April 2024",
4	"workspace": "finance_team_workspace",
5	"mount_point": "shared_drive_finance",
6	"repo_owner": "finance_dept",
7	"batch_owner": "alice.smith",
8	"created_at_ms": 1711804800000,
9	"updated_at_ms": 1712399600000,
10	"path_suffix": "batches/invoice_april_2024"
11	}

1	{
2	"id": 98765,
3	"name": "Invoice Processing Batch April 2024",
4	"workspace": "finance_team_workspace",
5	"mount_point": "shared_drive_finance",
6	"repo_owner": "finance_dept",
7	"batch_owner": "alice.smith",
8	"created_at_ms": 1711804800000,
9	"updated_at_ms": 1712399600000,
10	"path_suffix": "batches/invoice_april_2024"
11	}

$	curl "${API_ROOT}/v2/batches/<BATCH-ID>" \
>	-H "Authorization: Bearer ${API_TOKEN}" \
>	-H "IB-Context: ${IB_CONTEXT}"