Skip to main content
GET
/
v1
/
merchants
List merchants
curl --request GET \
  --url https://api.sbx.moduluslabs.io/reports/v1/merchants \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.moduluslabs.io/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns merchants visible to your API key. Results are sorted alphabetically by name.

​
Merchant IDs

Each merchant has a stable UUID that remains consistent across API calls. Use this ID with the merchant_id filter on /v1/transactions to get all transactions for a merchant. 
# 1. Get merchants
GET /v1/merchants
# Response: [{"id": "57846d47-...", "name": "Coffee Shop"}, ...]

# 2. Use the ID to filter transactions
GET /v1/transactions?merchant_id=57846d47-d196-5c48-a881-4003b1d5aa98

​
Next Steps

List Transactions

Filter transactions by merchant_id

List Branches

Get branches for a specific merchant

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Verified by APISIX via Vanguard. APISIX injects identity headers and strips the raw key before forwarding.

Response

Merchant list

​
data
object[]
required