---
title: "Search for Units (BETA)"
method: GET
path: "/units"
tags: ["Units"]
---

# Search for Units (BETA)

`GET /units`

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

## Query parameters

- `id` string, Int64
- `status` 'ACTIVE' | 'INACTIVE'
- `type` 'COMPANY' | 'OUTLET'
- `parentUnitId` boolean
- `tag` string, string
- `offset` integer
- `limit` integer
- `orderBy` 'id,ASC' | 'id,DESC' | 'name,ASC' | 'name,DESC' | 'safeName,ASC' | 'safeName,DESC'

## 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.

- UnitsSearchResponseEntity
  - `offset` integer — The number of units skipped when returning the data.
  - `limit` integer — The number of units limited in the results, up to a maximum of 100.
  - `total` integer — The total number of units matching your search.
  - `orderBy` object[] — How the results from your search were ordered.
    - `name` string — What column is being used to order.
    - `order` 'ASC' | 'DESC' — Whether the results are ordered ascending or descending.
  - `results` UnitResponseEntity[] — The list of units that match your search.
    - `id` Id — unresolved $ref
    - `name` Name — unresolved $ref
    - `safeName` SafeName — unresolved $ref
    - `type` TypeResponse — unresolved $ref
    - `unitRelations` UnitRelations — unresolved $ref
    - `status` Status — unresolved $ref
    - `reference` Reference — unresolved $ref
    - `tags` Tags — unresolved $ref
    - `incomingIdentifier` IncomingIdentifier — unresolved $ref
    - `outgoingIdentifier` OutgoingIdentifier — unresolved $ref
    - `timezones` Timezones — unresolved $ref

## 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/wallet-api.md) · [All operations](https://skmtc.dev/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/revisions/90a122bb14cc/schema)