API Reference
Expanding Entities
Expand certain entities within the API response.
Certain entities are returned as a unique ID for brevity. These entities can be expanded into the underlying object when specified via the
expand request parameter.
curl 'https://api.scale.com/v2/task'
curl 'https://api.scale.com/v2/task?expand=project'
{
"project": "abc123",
"batch": "efg456",
"delivery": "dce789",
...
}
{
"project": {
"id": "abc123",
"name": "My Project",
...
},
"batch": {
"id": "efg456",
"name": "my_batch_01",
},
"delivery": {
"id": "dce789",
"name": "delivery-math-01",
"task_count": 25,
"delivered_at": "2023-11-07T05:31:56Z",
"project": "abc123",
},
...
}
Entities that can be expanded from an ID to an object.
Available options:
project, batch, delivery Example:
{ "title": "Example" }