---
title: "List non-expired batches."
method: GET
path: "/batch"
---

# List non-expired batches.

`GET /batch`

## Request

- Base URL: `http://fss.ukho.gov.uk`
- URL: `http://fss.ukho.gov.uk/batch`
- Auth: HTTP bearer

Returns a list of batches in FSS with their files. Only committed batches that have not expired will be returned.

## Query parameters

- `limit` integer
- `start` integer
- `$filter` string

## Response `200`

OK - returns a list of batches.

- object
  - `count` integer: Number of batches that are in this page of the result. If there is only one page of results, this will equal `total`.
  - `total` integer: Total number of batches that match the query.
  - `entries` BatchDetails[]
    - `batchId` string, GUID
    - `status` 'Incomplete' | 'CommitInProgress' | 'Committed' | 'Rolledback' | 'Failed'
    - `allFilesZipSize` integer
    - `attributes` object[]
      - `key` string
      - `value` string
    - `businessUnit` string
    - `batchPublishedDate` string, date-time
    - `expiryDate` string, date-time
    - `isAllFilesZipAvailable` boolean: Indicates if the zip of all files in the batch is available. See "#/paths/batch/{batchId}/files"
    - `files` object[]
      - `filename` string
      - `fileSize` integer
      - `mimeType` string: The MIME content type of the file.
      - `hash` string, Base64: MD5 hash of the file content.
      - `attributes` object[]
        - `key` string
        - `value` string
      - `links` object: Contains links to the relevant APIs for this file.
        - `get` Link
          - `href` string, uri
  - `_links` Links: Links, usually describing links to next and previous pages in a paged result.
    - `self` Link
      - `href` string, uri
    - `first` Link
      - `href` string, uri
    - `previous` Link
      - `href` string, uri
    - `next` Link
      - `href` string, uri
    - `last` Link
      - `href` string, uri

## Other responses

- `400`: Bad request - there are one or more errors in the specified parameters, for example: a malformed query in the $filter; a request for results beyond the total count; an invalid page size (limit).
- `401`: Unauthorised - either you have not provided any credentials, or your credentials are not recognised.
- `403`: Forbidden - you have been authorised, but you are not allowed to access this resource.
- `429`: You have sent too many requests in a given amount of time. Please back-off for the time in the Retry-After header (in seconds) and try again.

---

[API](https://skmtc.dev/uk-hydrographic-office/apis/ukho-file-share-service-apis.md) - [All operations](https://skmtc.dev/uk-hydrographic-office/apis/ukho-file-share-service-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/uk-hydrographic-office/apis/ukho-file-share-service-apis/revisions/31121f0e92c4?raw)