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

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.

Returns branches visible to your API key, sorted alphabetically by name.

​
Filtering by Merchant

Use merchant_id to get branches for a specific merchant: 
GET /v1/branches?merchant_id=57846d47-d196-5c48-a881-4003b1d5aa98
Omit merchant_id to get all branches visible to your key.

​
Using Branch IDs

Use the branch_id from this endpoint to filter transactions: 
# 1. Get branches
GET /v1/branches
# Response: [{"id": "f3febca6-...", "name": "Main Street", "merchant_id": "57846d47-..."}, ...]

# 2. Filter transactions by branch
GET /v1/transactions?branch_id=f3febca6-7bd2-5d10-bcd7-1f796088e90c

​
Next Steps

List Merchants

Get merchant UUIDs to filter branches

List Transactions

Filter transactions by branch_id

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.

Query Parameters

​
merchant_id
string<uuid>

Filter by logical merchant UUID from the Merchant Registry. Works cross-DB — returns transactions from both databases if the merchant exists in both.

Response

Branch list

​
data
object[]
required