---
title: "Search Partners"
method: GET
path: "/api/v1/partner/search"
tags: ["Partner Management"]
---

# Search Partners

`GET /api/v1/partner/search`

## Request

- Base URL: `https://demo-api.edfapay.com`
- URL: `https://demo-api.edfapay.com/api/v1/partner/search`
- Auth: API key in header `X-API-KEY`

Search & Retrieve Partners, ACCESS LEVEL: SUPER_ADMIN, PARTNER

## Query parameters

- `pageProperties` SearchPageable, required
  - `pageNumber` integer
  - `sortDirection` 'ASC' | 'DESC'
  - `pageSize` integer
  - `sortBy` string
- `searchCriteria` PartnerSearchCriteria, required
  - `name` string
  - `nameAR` string
  - `address` string
  - `text` string
  - `active` boolean
  - `emailAddress` string
  - `registeredMobileNumber` string
  - `createdTimeTo` string, date
  - `createdTimeFrom` string, date
  - `businessUnitHierarchies` string[]

## Response `200`

OK

- ApiResponsePageObject
  - `code` integer
  - `message` string
  - `errorCode` string
  - `data` PageObject
    - `totalPages` integer
    - `totalElements` integer
    - `pageable` PageableObject
      - `paged` boolean
      - `pageNumber` integer
      - `pageSize` integer
      - `offset` integer
      - `sort` SortObject[]
        - `direction` string
        - `nullHandling` string
        - `ascending` boolean
        - `property` string
        - `ignoreCase` boolean
      - `unpaged` boolean
    - `first` boolean
    - `last` boolean
    - `size` integer
    - `content` object[]
    - `number` integer
    - `sort` SortObject[]
      - `direction` string
      - `nullHandling` string
      - `ascending` boolean
      - `property` string
      - `ignoreCase` boolean
    - `numberOfElements` integer
    - `empty` boolean

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/edfapay/apis/edfapay-api-docs.md) - [All operations](https://skmtc.dev/edfapay/apis/edfapay-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/edfapay/apis/edfapay-api-docs/revisions/36a4400e0455?raw)