---
title: "Lists the businesses the token may act for, with their stores; an account token lists them whatever its access."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo merchant API › organization

`GET /v1/merchants`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `organization:read`

## Query parameters

- `merchant` (`listMerchants.query.merchant`; string, optional) — An id.
  - minLength 1
- `store` (`listMerchants.query.store`; string, optional) — An id.
  - minLength 1
- `cursor` (`listMerchants.query.cursor`; string, optional) — Lists the memberships past a previous page, from that page's `cursor`.
  - maxLength 1024

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.sherpo.io/merchant/v1/merchants \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/merchants';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/merchants"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Lists the businesses the token may act for, with their stores; an account token lists them whatever its access.

#### Example

```json
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "short_name": "string",
      "created_at": "string",
      "scopes": [
        "string"
      ],
      "swatch": "string",
      "logo": "string",
      "stores": {
        "items": [
          {
            "id": "string",
            "name": "string",
            "hostname": "string",
            "url": "string",
            "swatch": "string",
            "icon": "string"
          }
        ],
        "total": 0
      }
    }
  ],
  "total": 0,
  "owns_suspended": true,
  "cursor": "string"
}
```

- `items` (`listMerchants.response.200.items`; array<object>, required)
  - `id` (`listMerchants.response.200.items.id`; string, required)
  - `name` (`listMerchants.response.200.items.name`; string, required)
  - `short_name` (`listMerchants.response.200.items.short_name`; string, required)
  - `created_at` (`listMerchants.response.200.items.created_at`; any of, required)
    - any of: `string`, `null`
  - `scopes` (`listMerchants.response.200.items.scopes`; any of, required) — The scopes their membership spells, not narrowed to the credential presented.
    - any of: `array<string>`, `null`
  - `swatch` (`listMerchants.response.200.items.swatch`; any of, required)
    - any of: `string`, `null`
  - `logo` (`listMerchants.response.200.items.logo`; any of, required)
    - any of: `string`, `null`
  - `stores` (`listMerchants.response.200.items.stores`; object, required)
    - `items` (`listMerchants.response.200.items.stores.items`; array<object>, required)
      - `id` (`listMerchants.response.200.items.stores.items.id`; string, required)
      - `name` (`listMerchants.response.200.items.stores.items.name`; string, required)
      - `hostname` (`listMerchants.response.200.items.stores.items.hostname`; any of, required)
        - any of: `string`, `null`
      - `url` (`listMerchants.response.200.items.stores.items.url`; any of, required) — The store home's absolute URL on its verified hostname, or null before it has one.
        - any of: `string`, `null`
      - `swatch` (`listMerchants.response.200.items.stores.items.swatch`; any of, required)
        - any of: `string`, `null`
      - `icon` (`listMerchants.response.200.items.stores.items.icon`; string, required)
    - `total` (`listMerchants.response.200.items.stores.total`; number, required)
- `total` (`listMerchants.response.200.total`; number, required)
- `owns_suspended` (`listMerchants.response.200.owns_suspended`; boolean, required)
- `cursor` (`listMerchants.response.200.cursor`; any of, required) — The next page's, null on the last; a page its seats leave empty may still have one.
  - any of: `string`, `null`

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`listMerchants.response.default.type`; string, required)
  - format `uri`
- `title` (`listMerchants.response.default.title`; string, required)
- `status` (`listMerchants.response.default.status`; integer, required)
- `detail` (`listMerchants.response.default.detail`; string, required)
- `code` (`listMerchants.response.default.code`; string, optional)
- `context` (`listMerchants.response.default.context`; object, optional)
- `reached_core` (`listMerchants.response.default.reached_core`; boolean, optional)
- `core_answer` (`listMerchants.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/list-merchants/index.md
