---
title: "Get merchant list"
method: GET
path: "/api/demographics/v1/Merchants"
tags: ["Merchant"]
---

# Get merchant list

`GET /api/demographics/v1/Merchants`

Retrieve a list of merchants with optional filter pagination capabilities.

## Query parameters

- `PageSize` integer, required
- `PageNumber` integer, required

## Response `200`

Returns a list of merchants successfully.

- MerchantDemographicsApiModelsBusinessListItemWithLinksCollection
  - `content` MerchantDemographicsApiModelsBusinessListItemWithLinks[], nullable — Contains the list of merchant records and pagination details.
    - `_links` object, nullable — Reference link to fetch merchant’s detailed information.
    - `hierarchyNodeKey` string, nullable — Identifier for the merchant’s hierarchy node.
    - `dbaName` string, nullable — Doing-Business-As (DBA) name of the merchant.
    - `merchantNumber` string, nullable — Unique merchant identifier.
  - `page` MerchantDemographicsApiModelsPagination — Paging information for merchant records.
    - `number` integer — Current page number in the result.
    - `size` integer — The number of records returned per page.
    - `sort` MerchantDemographicsApiModelsPageSort
      - `fields` object, nullable — Sorting criteria applied to the results.
    - `totalPages` integer — Total number of available pages.
    - `numberOfElements` integer — Number of elements in the current page.
    - `totalElements` integer — Total number of merchants available.
    - `first` boolean — Indicates if this is the first page.
    - `last` boolean — Indicates if this is the last page.

## Other responses

- `500` — Error occurred retrieving data.

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/versions/f37077c24b66/schema)