---
title: "List merchants"
method: GET
path: "/v1/merchants"
tags: ["Merchants"]
---

# List merchants

`GET /v1/merchants`

Query a list of merchants given optional search criteria.

## Query parameters

- `platform_id` string
- `merchant_id` string
- `name` string
- `status` string[]
- `billing_profile_id` string[]
- `created_at.start` string, date-time
- `created_at.end` string, date-time
- `updated_at.start` string, date-time
- `updated_at.end` string, date-time
- `latest_merchant_application_status` string[]
- `sort_by` 'merchant_id' | 'name' | 'status' | 'created_at' | 'updated_at'
- `sort_order` 'asc' | 'desc'
- `limit` number
- `offset` number

## Headers

- `Rainforest-Api-Version` '2024-10-16' | '2023-12-01'

## Parameters

- `#/paths/~1v1~1merchants/get/parameters/8` — unresolved $ref
- `#/paths/~1v1~1merchants/get/parameters/9` — unresolved $ref

## Response `200`

OK

- object
  - `status` 'SUCCESS' | 'ERROR' — Status of the request. If the request status code is 2XX, then the `status` will be `SUCCESS`. If the request status code is 4XX or 5XX, then the `status` will be `ERROR`.
  - `data` object
    - `total_results` integer — Total number of results available. This value will be -1 if the query parameter `omit_total_results` is set to true.
    - `results` 0[] — List of merchants. — unresolved $ref
  - `errors` object[] — List of errors, if applicable.
    - `field` string — The field in the request that had an error, if applicable.
    - `code` string — The code describing the error.
    - `message` string — The description of the error related to the field.

## Other responses

- `400` — Bad request, check for validation errors.
- `401` — Authorization missing or invalid.
- `403` — Authorization insufficient for requested action.
- `404` — Resource not found.
- `5XX` — Unexpected error.

---

[API](https://skmtc.dev/rainforestpay/apis/authentication.md) · [All operations](https://skmtc.dev/rainforestpay/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rainforestpay/authentication/revisions/529a0dab0f90/schema)