List batches

GET

Return a list of batches. Use query parameters to filter results.

Headers

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.

Query parameters

workspacestringOptional

Filter to batches in the specified workspace.

usernamestringOptional

Filter to batches created by the specified username (user ID).

limitintegerOptional

If paginating results, specify how many batches to return.

offsetintegerOptional

If paginating results, specify the offset of the returned list.

Response

This endpoint returns an object.

batcheslist of objectsOptional

List of batches. See response schema for each batch object.

1	curl "${API_ROOT}/v2/batches" \
2	-H "Authorization: Bearer ${API_TOKEN}" \
3	-H "IB-Context: ${IB_CONTEXT}"\
4	-G \
5	--data-urlencode "workspace=my-workspace" \
6	--data-urlencode "limit=100"

1	{
2	"batches": [
3	{
4	"id": 1,
5	"name": "name",
6	"workspace": "workspace",
7	"mount_point": "mount_point",
8	"repo_owner": "repo_owner",
9	"batch_owner": "batch_owner",
10	"created_at_ms": 1000000,
11	"updated_at_ms": 1000000,
12	"path_suffix": "path_suffix"
13	}
14	]
15	}