Skip to main content
GET
/
merchants
JavaScript
import HenrySDK from '@henrylabs/sdk';

const client = new HenrySDK({
  apiKey: process.env['HENRY_SDK_API_KEY'], // This is the default and can be omitted
});

const merchants = await client.merchants.list();

console.log(merchants.data);
{
  "success": true,
  "status": "<string>",
  "message": "<string>",
  "data": [
    {
      "host": "<string>",
      "name": "<string>",
      "description": "<string>",
      "website": {
        "urls": [
          {
            "value": "<string>",
            "type": "landing"
          }
        ]
      },
      "logo": {
        "urls": [
          {
            "value": "<string>"
          }
        ]
      },
      "categories": [
        "automotive"
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

cursor
string

Cursor returned from the previous response

Example:

"2023-01-01T00:00:00Z"

limit
number
default:20

Limit the number of results

Required range: 1 <= x <= 100
Example:

20

host
string

Filter merchants by host

Minimum string length: 1
Example:

"nike.com"

name
string

Filter merchants by name (partial match)

Minimum string length: 1
Example:

"nike"

categories
enum<string>[]
Minimum array length: 1
Available options:
automotive,
baby_and_kids,
ecommerce,
electronics_and_gadgets,
fashion_and_accessories,
finance,
food,
health_and_beauty,
home_and_living,
lifestyle_and_entertainment,
other,
sports_and_outdoor,
travel,
education

Response

Merchants fetched successfully

success
boolean
required
status
string
required
message
string
required
data
object[]
required