---
title: "Search for Token Formats"
method: GET
path: "/tokenFormats"
tags: ["Token Formats"]
---

# Search for Token Formats

`GET /tokenFormats`

## Request

- Base URL: `https://resources.uk.eagleeye.com`
- URL: `https://resources.uk.eagleeye.com/tokenFormats`
- Auth: none declared. Required headers: `X-EES-AUTH-CLIENT-ID`, `X-EES-AUTH-HASH`

This method allows the calling application to search token formats using query parameters.

## Query parameters

- `id[]` integer
- `safeName` string, int64
- `name` string
- `offset` integer
- `limit` integer
- `orderBy` string

## Headers

- `X-EES-AUTH-CLIENT-ID` string, string, required
- `X-EES-AUTH-HASH` string, string, required
- `Accept-Encoding` '' | 'gzip' | 'deflate' | 'gzip,deflate'
- `X-EES-TRANSACTION-ID` string, string
- `X-EES-RETRY` string, string

## Response `200`

OK.

- TokenFormatSearch
  - `offset` integer: The number of Token Formats skipped when returning the data.
  - `limit` integer: The number of Token Formats limited in the results, up to a maximum of 100.
  - `total` integer: The total number of token formats matching your search.
  - `orderBy` object[]: How to order the results returned from your search.
    - `name` string: What column is being used to order.
    - `order` 'ASC' | 'DESC': Whether the results are ordered ascending or descending.
  - `results` TokenFormatEntity[]: The list of token formats that match your search.
    - `id` integer: The id of a token format automatically generated and unique within Eagle Eye AIR.
    - `name` string: The name of the token format.
    - `safeName` string: a unique reference for the token format
    - `details` object
      - `checksum` boolean: Whether this token format uses checksum to self-validate.
      - `format` string: The format that is acceptable for a valid token. The following characters should be used to write the format: <br> # : Digit 0-9 <br> ~ : Digits 1-9 <br> A : Uppercase Letter <br> - : Hyphen <br> X : Uppercase Letter excl. I & O <br> * : Alphanumeric <br> ^ : Alphanumeric excl. I & O
      - `length` integer: The length of a valid token.
      - `prefix` string, nullable: Characters that prefix every token of this format.
      - `suffix` string, nullable: Characters that suffix every token of this format.

## Other responses

- `400`: Bad Request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `405`: Method Not Allowed.
- `429`: Too Many Requests
- `500`: Server Error
- `501`: Not Implemented
- `502`: Bad Gateway
- `503`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/eagleeye/apis/resource-api.md) - [All operations](https://skmtc.dev/eagleeye/apis/resource-api/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeye/apis/resource-api/revisions/10217d37fdc5?raw)