Skip to main content
GET
/
v2
/
batches
API_KEY='live_...'
PARAMS='project_name=My+Test+Project&status=completed&limit=10'
curl --request GET \
    --url "https://api.scale.com/v2/batches?$PARAMS" \
    --header "Authorization: Bearer $API_KEY"
{
  "batches": [
    {
      "$ref": "#/components/examples/SampleBatch/value"
    }
  ],
  "next_token": "imatoken123"
}
Every request sent to Scale’s API requires authentication. In short, your API Key is the Bearer token. See the Authentication section for more details.

Authorizations

​
Authorization
string
header
required

Your API Key is the Bearer token. See the Authentication section to learn how to access your key.

Query Parameters

​
project_id
string

Scale's unique identifier for the project. A unique identifier for the project.

Example:

"project_abc123"

​
project_name
string

The name of the project.

Example:

"My Scale Project"

​
status
enum<string>

The current status of the batch, indicating whether it is staging, in_progress, completed, or paused. Status of the batch.

Available options:
staging,
in_progress,
completed,
paused,
cancelled
​
created_after
string<date-time>

A timestamp formatted as an ISO 8601 date-time string.

​
created_before
string<date-time>

A timestamp formatted as an ISO 8601 date-time string.

​
completed_after
string<date-time>

A timestamp formatted as an ISO 8601 date-time string.

​
completed_before
string<date-time>

A timestamp formatted as an ISO 8601 date-time string.

​
limit
integer

Limit the number of entities returned.

Required range: 1 <= x <= 100
​
next_token
string

A token used to retrieve the next page of results if there are more. You can find the next_token in your last request

​
expand
enum<string>[]

List of fields to expand in the response. Entities that can be expanded from an ID to an object.

Entities that can be expanded from an ID to an object.

Available options:
project

Response

List of batches.

​
batches
object[]
required

Array of batch objects

​
next_token
string

A token used to retrieve the next page of results if there are more. You can find the next_token in your last request