---
title: "Pages the store's files."
---

> 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 › file

`GET /v1/stores/{store}/assets`

## Authentication

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

## Path parameters

- `store` (`listAssets.path.store`; string, required) — The store's id.

## Query parameters

- `filter` (`listAssets.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listAssets.query.sort`; string, optional)
  - one of `"created"`, `"name"`, `"size"`
- `direction` (`listAssets.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listAssets.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listAssets.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listAssets.query.count`; boolean, optional)
- `search` (`listAssets.query.search`; string, optional)
  - minLength 1; maxLength 200
- `facets` (`listAssets.query.facets`; array<string>, optional)

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/assets';
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/stores/<store>/assets"

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

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

print(response.text)
```

## Responses

### 200

Pages the store's files.

#### Example

```json
{
  "items": [
    {
      "uses": {
        "total": 0,
        "first": {
          "attachment_id": "string",
          "asset_id": "string",
          "role": "string",
          "delivery": "string",
          "target": {
            "kind": "string",
            "id": "string"
          },
          "from_body": true,
          "detachable": true,
          "release": {
            "id": "string",
            "version": "string",
            "current": true,
            "after": {
              "id": "string",
              "version": "string"
            }
          }
        }
      },
      "replace_failed": true,
      "movable": true,
      "id": "string",
      "locator": "string",
      "origin": "string",
      "custodian": "string",
      "enforcement": "string",
      "mime": "string",
      "bytes": 0,
      "quota_bytes": 0,
      "name": "string",
      "title": "string",
      "ext": "string",
      "status": "string",
      "optimized": true,
      "parent_id": "string",
      "redacted": true,
      "security": "string",
      "description": "string",
      "processed_at": "string",
      "metadata": {
        "width": 0,
        "height": 0,
        "duration": 0,
        "pages": 0,
        "waveform": "string",
        "transcript": {
          "language": "string",
          "confidence": 0
        },
        "arguments": [
          {
            "name": "string",
            "description": "string",
            "required": true,
            "default": "string",
            "match": "string",
            "flags": "string",
            "message": "string",
            "lenient": true
          }
        ],
        "property1": true,
        "property2": true
      },
      "created_at": "string"
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listAssets.response.200.items`; array<object>, required)
  - `uses` (`listAssets.response.200.items.uses`; object, required)
    - `total` (`listAssets.response.200.items.uses.total`; number, required)
    - `first` (`listAssets.response.200.items.uses.first`; any of, required)
      - any of: `object`, `null`
  - `replace_failed` (`listAssets.response.200.items.replace_failed`; boolean, required)
  - `movable` (`listAssets.response.200.items.movable`; boolean, required)
  - `id` (`listAssets.response.200.items.id`; string, required)
  - `locator` (`listAssets.response.200.items.locator`; any of, required)
    - any of: `string`, `null`
  - `origin` (`listAssets.response.200.items.origin`; string, required)
  - `custodian` (`listAssets.response.200.items.custodian`; string, required)
  - `enforcement` (`listAssets.response.200.items.enforcement`; string, required)
  - `mime` (`listAssets.response.200.items.mime`; any of, required)
    - any of: `string`, `null`
  - `bytes` (`listAssets.response.200.items.bytes`; any of, required) — The file's size in bytes; null when it is charged nothing.
    - any of: `number`, `null`
  - `quota_bytes` (`listAssets.response.200.items.quota_bytes`; number, required) — The file's size in bytes; zero when it is charged nothing.
  - `name` (`listAssets.response.200.items.name`; string, required)
  - `title` (`listAssets.response.200.items.title`; any of, required)
    - any of: `string`, `null`
  - `ext` (`listAssets.response.200.items.ext`; any of, required)
    - any of: `string`, `null`
  - `status` (`listAssets.response.200.items.status`; string, required)
  - `optimized` (`listAssets.response.200.items.optimized`; boolean, required)
  - `parent_id` (`listAssets.response.200.items.parent_id`; any of, required)
    - any of: `string`, `null`
  - `redacted` (`listAssets.response.200.items.redacted`; boolean, required)
  - `security` (`listAssets.response.200.items.security`; any of, required)
    - any of: `string`, `null`
  - `description` (`listAssets.response.200.items.description`; any of, required)
    - any of: `string`, `null`
  - `processed_at` (`listAssets.response.200.items.processed_at`; any of, required)
    - any of: `string`, `null`
  - `metadata` (`listAssets.response.200.items.metadata`; object, required)
    - `width` (`listAssets.response.200.items.metadata.width`; integer, optional)
      - min 0
    - `height` (`listAssets.response.200.items.metadata.height`; integer, optional)
      - min 0
    - `duration` (`listAssets.response.200.items.metadata.duration`; number, optional) — Seconds, measured, so rarely whole.
    - `pages` (`listAssets.response.200.items.metadata.pages`; integer, optional)
      - min 0
    - `waveform` (`listAssets.response.200.items.metadata.waveform`; any of, optional) — An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.
      - any of: `string`, `null`
    - `transcript` (`listAssets.response.200.items.metadata.transcript`; object, optional)
      - `language` (`listAssets.response.200.items.metadata.transcript.language`; string, optional)
      - `confidence` (`listAssets.response.200.items.metadata.transcript.confidence`; number, optional)
    - `arguments` (`listAssets.response.200.items.metadata.arguments`; array<object>, optional) — What an MCP prompt asks for; only an authored prompt carries it.
      - `name` (`listAssets.response.200.items.metadata.arguments.name`; string, required)
      - `description` (`listAssets.response.200.items.metadata.arguments.description`; any of, required)
        - any of: `string`, `null`
      - `required` (`listAssets.response.200.items.metadata.arguments.required`; boolean, required)
      - `default` (`listAssets.response.200.items.metadata.arguments.default`; any of, required)
        - any of: `string`, `null`
      - `match` (`listAssets.response.200.items.metadata.arguments.match`; any of, required) — Pattern the whole value must match, diacritic-insensitive.
        - any of: `string`, `null`
      - `flags` (`listAssets.response.200.items.metadata.arguments.flags`; any of, required) — Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.
        - any of: `string`, `null`
      - `message` (`listAssets.response.200.items.metadata.arguments.message`; any of, required) — What a refused value is told instead of the default reason.
        - any of: `string`, `null`
      - `lenient` (`listAssets.response.200.items.metadata.arguments.lenient`; boolean, required)
  - `created_at` (`listAssets.response.200.items.created_at`; any of, required)
    - any of: `string`, `null`
- `cursor` (`listAssets.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listAssets.response.200.total`; number, optional)
- `facets` (`listAssets.response.200.facets`; map<map<number>>, optional)

### 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` (`listAssets.response.default.type`; string, required)
  - format `uri`
- `title` (`listAssets.response.default.title`; string, required)
- `status` (`listAssets.response.default.status`; integer, required)
- `detail` (`listAssets.response.default.detail`; string, required)
- `code` (`listAssets.response.default.code`; string, optional)
- `context` (`listAssets.response.default.context`; object, optional)
- `reached_core` (`listAssets.response.default.reached_core`; boolean, optional)
- `core_answer` (`listAssets.response.default.core_answer`; string, optional)


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