---
title: "Returns a list of batch requests submitted and the status for each request"
method: GET
path: "/document/batches"
---

# Returns a list of batch requests submitted and the status for each request

`GET /document/batches`

Returns a list of batch requests submitted and the status for each
request.
This list only contains batch requests submitted by the user (based on
the resource).
            
If the number of requests exceeds our paging limit,
server-side paging is used. Paginated responses indicate a partial result and
include a continuation token in the response.
The absence of a continuation
token means that no additional pages are available.
            
top, skip
and maxpagesize query parameters can be used to specify a number of results to
return and an offset for the collection.
            
top indicates the total
number of records the user wants to be returned across all pages.
skip
indicates the number of records to skip from the list of batches based on the
sorting method specified.  By default, we sort by descending start
time.
maxpagesize is the maximum items returned in a page.  If more items are
requested via top (or top is not specified and there are more items to be
returned), @nextLink will contain the link to the next page.
           

orderby query parameter can be used to sort the returned list (ex
"orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc
desc").
The default sorting is descending by createdDateTimeUtc.
Some query
parameters can be used to filter the returned list (ex:
"status=Succeeded,Cancelled") will only return succeeded and cancelled
operations.
createdDateTimeUtcStart and createdDateTimeUtcEnd can be used
combined or separately to specify a range of datetime to filter the returned
list by.
The supported filtering query parameters are (status, ids,
createdDateTimeUtcStart, createdDateTimeUtcEnd).
            
The server honors
the values specified by the client. However, clients must be prepared to handle
responses that contain a different page size or contain a continuation token.
 
          
When both top and skip are included, the server should first apply
skip and then top on the collection.
Note: If the server can't honor top
and/or skip, the server must return an error to the client informing about it
instead of just ignoring the query options.
This reduces the risk of the client
making assumptions about the data returned.

## Query parameters

- `api-version` string, required
- `top` integer
- `skip` integer
- `maxpagesize` integer
- `ids` string[]
- `statuses` string[]
- `createdDateTimeUtcStart` string, date-time
- `createdDateTimeUtcEnd` string, date-time
- `orderby` string[]

## Response `200`

The request has succeeded.

- TranslationsStatus — Translation job Status Response
  - `value` TranslationStatus[], required — The summary status of individual operation
    - `id` string, required — Id of the translation operation.
    - `createdDateTimeUtc` string, date-time, required — Operation created date time
    - `lastActionDateTimeUtc` string, date-time, required — Date time in which the operation's status has been updated
    - `status` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Cancelled' | 'Cancelling' | 'ValidationFailed', required — List of possible statuses for job or document
    - `error` TranslationError — This contains an outer error with error code, message, details, target and an inner error with more descriptive details.
      - `code` 'InvalidRequest' | 'InvalidArgument' | 'InternalServerError' | 'ServiceUnavailable' | 'ResourceNotFound' | 'Unauthorized' | 'RequestRateTooHigh', required — Enums containing high level error codes.
      - `message` string, required — Gets high level error message.
      - `target` string — Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document.
      - `innerError` InnerTranslationError — New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
        - `code` string, required — Gets code error string.
        - `message` string, required — Gets high level error message.
        - `target` string — Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document.
        - `innerError` InnerTranslationError — recursive
    - `summary` StatusSummary, required — Status Summary
      - `total` integer, required — Total count
      - `failed` integer, required — Failed count
      - `success` integer, required — Number of Success
      - `inProgress` integer, required — Number of in progress
      - `notYetStarted` integer, required — Count of not yet started
      - `cancelled` integer, required — Number of cancelled
      - `totalCharacterCharged` integer, required — Total characters charged by the API
      - `totalImageScansSucceeded` integer — Total image scans charged by the API
      - `totalImageScansFailed` integer — Total image scans failed
      - `totalImageCharged` integer — Total images charged by the API
  - `nextLink` string — Url for the next page. Null if no more pages available

## Other responses

- `default` — An unexpected error response.

## Changes

- **2026-07-13** (2023-11-01-preview) `2a29f2b714b8` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/azure/apis/translation-documenttranslation/changes/document/batches/get.md)

---

[API](https://skmtc.dev/azure/apis/translation-documenttranslation.md) · [All operations](https://skmtc.dev/azure/apis/translation-documenttranslation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/translation-documenttranslation/revisions/f29cf344b9da/schema)