> For the complete documentation index, see [llms.txt](https://annotationdocs.telusinternational.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://annotationdocs.telusinternational.com/basic-operations/get-batch-jobs.md).

# Get batch jobs

## BATCH JOBS

<mark style="color:blue;">`GET`</mark> `https://api.playment.io/v1/projects/:project_id/batch/:batch_id?page_token=:next_page_token`

Get a list of all jobs in a batch.\
The number of jobs in a batch is usually huge, so this API has pagination

#### Path Parameters

| Name              | Type   | Description                                                                                                                                                                               |
| ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| next\_page\_token | string | You can leave this parameter blank for the first page. In the response of the first page, you'll get a token against the `data.next_page_token` key. Use this token to get the next page. |
| batch\_id         | string | ID of the batch for which you want to fetch a list of jobs                                                                                                                                |
| project\_id       | string | ID of the project which has this batch                                                                                                                                                    |

#### Headers

| Name      | Type   | Description                |
| --------- | ------ | -------------------------- |
| x-api-key | string | API key for authentication |

{% tabs %}
{% tab title="200 " %}

```javascript
{
    "data": {
        "id": "",
        "project_id": "",
        "name": "Batch 1",
        "jobs": [
            {
                "id": "fde5ert6-eb32-481a-807a-03a0428ca836",
                "reference_id": "001",
                "status": "completed",
                "frames": 1,
                "annotations": 1
            },
            {
                "id": "fdda8970-dr3d-4978-9ce3-e80654d8078c",
                "reference_id": "002",
                "status": "completed",
                "frames": 1,
                "annotations": 1
            }
        ],
        "next_page_token": "1575822103313046000"
    },
    "success": true
}
```

{% endtab %}
{% endtabs %}

You can iterate over the list of jobs received in the response and call the [Get job result API](/basic-operations/get-job-results.md) to get the annotation results for each job.&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://annotationdocs.telusinternational.com/basic-operations/get-batch-jobs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.