Get Merchants

GET {{BASE_HABITAT_URL}}/api/v3/merchants?limit=1&sort=asc

Required scope: merchants:read

Fetch all merchants for your workspace, limited to 250 per fetch, but with pagination options.

Examples

cURL

curl --request GET '${BASE_HABITAT_URL}/api/v3/merchants?limit=1&sort=asc'

Node.js

const response = await fetch("${BASE_HABITAT_URL}/api/v3/merchants?limit=1&sort=asc", {
  "method": "GET",
  "headers": {}
})
const data = await response.json()

Python

import requests

response = requests.request(
    "GET",
    "${BASE_HABITAT_URL}/api/v3/merchants?limit=1&sort=asc",
    headers={},
)
response.raise_for_status()

Saved responses

200 Get Merchants

{
    "type": "success",
    "data": [
        {
            "id": "66ea2921-c416-11ed-85d7-2b8b3a8b5eeb",
            "created_at": "2023-03-16T16:20:01.825Z",
            "name": "mikes test",
            "location": {
                "address": "2211 E Hagert St, Philadelphia, PA 19125, USA",
                "coordinates": {
                    "type": "Point",
                    "coordinates": [
                        -75.1251352,
                        39.9808023
                    ]
                }
            },
            "phone": "12333322311",
            "email": "test-account@firstdelivey.com",
            "habitat": "4146ce29-852e-4b1d-a7a4-55699a057419",
            "territory": "a953b4be-ae6f-43f8-a77d-49be62c3fef2",
            "timezone": "America/New_York",
            "operator_id": 1,
            "archived": null,
            "options": {
                "prep_time": 20,
                "pickup_instructions": null,
                "auto_accept": false,
                "priority": false
            },
            "rates": {
                "daas_rate": null,
                "oozo_rate": null,
                "catering_rate": null,
                "scheduled_rate": 15,
                "diner_delivery_fee": null,
                "runner_commission": null
            },
            "billing": {
                "enabled": true,
                "stripe_id": null,
                "invoice_email": "test-account@firstdelivey.com",
                "invoice_default_type": null
            }
        }
    ],
    "total": 18
}