MerchantHQ API
GET /2024-09/merchants
Default

Get the list of merchants you have access to.

Query parameters

  • q string

    A search query to filter the merchants by name.

  • per_page integer

    The number of results to return per page

    Minimum value is 1, maximum value is 100.

Responses

  • 200 application/json

    A successful response returning the list of merchants.

    Hide response attributes Show response attributes object
    • links object
      Hide links attributes Show links attributes object
      • first string
      • last string
      • prev string | null
      • next string | null
    • meta object
      Hide meta attributes Show meta attributes object
      • current_page integer
      • from integer | null
      • last_page integer
      • path string
      • per_page integer
      • to integer | null
      • total integer
    • data array[object] Required

      Representation of a merchant

      Hide data attributes Show data attributes object
      • name string

        The user-defined name of the merchant

        Maximum length is 255.

      • id string(uuid)

        The UUID of the resource.

      • created_at string(date-time)

        The date and time the resource was created.

      • updated_at string(date-time)

        The date and time the resource was last updated.
  • 401 application/json

    The request requires user authentication or the user is not authorized to access this resource.

    Hide response attribute Show response attribute object
    • message string
  • 404 application/json

    The specified resource was not found

    Hide response attribute Show response attribute object
    • message string
GET /2024-09/merchants 
curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/merchants' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "links": {
    "first": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "last": "https://app.merchanthq.com/api/2024-09/merchants?page=10",
    "prev": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "next": "https://app.merchanthq.com/api/2024-09/merchants?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "https://app.merchanthq.com/api/2024-09/merchants",
    "per_page": 10,
    "to": 10,
    "total": 20
  },
  "data": [
    {
      "name": "ACME Corp",
      "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
      "created_at": "2025-01-10T10:37:11Z",
      "updated_at": "2025-01-10T10:37:11Z"
    }
  ]
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (404) 
{
  "message": "Not found"
}