---
title: "Search Branches"
method: GET
path: "/api/v1/branches/search"
tags: ["Branch Management"]
---

# Search Branches

`GET /api/v1/branches/search`

Search & Retrieve Branches, ACCESS LEVEL: SUPER_ADMIN, PARTNER, MERCHANT

## Query parameters

- `pageProperties` SearchPageable, required
  - `pageNumber` integer
  - `sortDirection` 'ASC' | 'DESC'
  - `pageSize` integer
  - `sortBy` string
- `searchCriteria` BranchSearchCriteria, required
  - `text` string
  - `countryCode` string
  - `cityId` string
  - `address` string
  - `active` boolean
  - `createdTimeTo` string, date
  - `createdTimeFrom` string, date
  - `businessUnitHierarchies` string[]

## Response `200`

OK

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/edfapay/apis/revamp.md) · [All operations](https://skmtc.net/edfapay/apis/revamp/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/edfapay/revamp/versions/8104cc1c9e38/schema)