---
title: "Get a list of batch attributes and their values for a batch search."
method: GET
path: "/attributes/search"
---

# Get a list of batch attributes and their values for a batch search.

`GET /attributes/search`

## Request

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

Get a list of the batch attributes and their values that have been applied to batches for a batch search.

## Query parameters

- `$filter` string
- `maxAttributeValueCount` integer

## Response `200`

Returns a dictionary of the batch attributes and values that exist for the batches identified by the search.

Note : Some attributes (such as `TraceID`) are excluded from this list because they are likely to unique values for each batch. Also, the number of values returned for each attribute is limited to 25. If the attribute value list is truncated, the last entry will be `...`.

- object
  - `searchBatchCount` integer: Total number of batches that match the query.
  - `batchAttributes` object

## Other responses

- `400`: Bad request - there are one or more errors in the specified parameters, for example: a malformed query in the $filter.
- `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)