HEherondata
Merchants

List merchants

Changed on

Get a paginated list of merchants with optional name and group_id filtering. Results are ordered by merchant ID for stable pagination.

get/api/merchants/list

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/merchants/list
  • Auth
    API key in header x-api-key

Query parameters

namestring

Filter merchants by name (full or partial match)

group_idstring

Filter merchants by group ID

limitinteger

Number of merchants to return per page

offsetinteger

Number of merchants to skip

Response

List of merchants with pagination metadata

has_moreboolean
limitinteger
offsetinteger
totalinteger

Example response

{
  "data": [
    {
      "heron_id": "mrc_Qc7dvS9RnASVzUMxxfVgsZ"
    }
  ]
}

Changes

  • bd8008e49534Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new debt.collections.mca enum value to the // response property for the response status

    • info

      removed the optional write-only property data/items/category_codes from the response with the status

    • info

      removed the optional write-only property data/items/frequency from the response with the status