---
title: "Pages a product's certificates."
---

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

`GET /v1/stores/{store}/products/{product}/certificates`

## Authentication

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

## Path parameters

- `store` (`listCertificates.path.store`; string, required) — The store's id.
- `product` (`listCertificates.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

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

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages a product's certificates.

#### Example

```json
{
  "items": [
    {
      "logo": {
        "attachment_id": "string",
        "asset_id": "string"
      },
      "issued": 0,
      "id": "string",
      "product_id": "string",
      "quiz_id": "string",
      "headline_copy": "string",
      "title_copy": "string",
      "awarded_copy": "string",
      "reason_copy": "string",
      "score_copy": "string",
      "out_of_score_copy": "string",
      "settings": {
        "template": "string",
        "accent": "string",
        "requires_passing": true,
        "earned_on": "string",
        "shows": [
          "string"
        ]
      },
      "created_at": "string"
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listCertificates.response.200.items`; array<object>, required)
  - `logo` (`listCertificates.response.200.items.logo`; any of, required)
    - any of: `object`, `null`
  - `issued` (`listCertificates.response.200.items.issued`; number, required)
  - `id` (`listCertificates.response.200.items.id`; string, required)
  - `product_id` (`listCertificates.response.200.items.product_id`; string, required)
  - `quiz_id` (`listCertificates.response.200.items.quiz_id`; any of, required)
    - any of: `string`, `null`
  - `headline_copy` (`listCertificates.response.200.items.headline_copy`; string, required)
  - `title_copy` (`listCertificates.response.200.items.title_copy`; any of, required)
    - any of: `string`, `null`
  - `awarded_copy` (`listCertificates.response.200.items.awarded_copy`; any of, required)
    - any of: `string`, `null`
  - `reason_copy` (`listCertificates.response.200.items.reason_copy`; any of, required)
    - any of: `string`, `null`
  - `score_copy` (`listCertificates.response.200.items.score_copy`; any of, required)
    - any of: `string`, `null`
  - `out_of_score_copy` (`listCertificates.response.200.items.out_of_score_copy`; any of, required)
    - any of: `string`, `null`
  - `settings` (`listCertificates.response.200.items.settings`; object, required)
    - `template` (`listCertificates.response.200.items.settings.template`; string, required)
    - `accent` (`listCertificates.response.200.items.settings.accent`; any of, required)
      - any of: `string`, `null`
    - `requires_passing` (`listCertificates.response.200.items.settings.requires_passing`; boolean, optional) — Earned by passing the quiz, not by merely finishing it.
    - `earned_on` (`listCertificates.response.200.items.settings.earned_on`; string, optional) — Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.
    - `shows` (`listCertificates.response.200.items.settings.shows`; array<string>, optional)
  - `created_at` (`listCertificates.response.200.items.created_at`; any of, required)
    - any of: `string`, `null`
- `cursor` (`listCertificates.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listCertificates.response.200.total`; number, optional)
- `facets` (`listCertificates.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` (`listCertificates.response.default.type`; string, required)
  - format `uri`
- `title` (`listCertificates.response.default.title`; string, required)
- `status` (`listCertificates.response.default.status`; integer, required)
- `detail` (`listCertificates.response.default.detail`; string, required)
- `code` (`listCertificates.response.default.code`; string, optional)
- `context` (`listCertificates.response.default.context`; object, optional)
- `reached_core` (`listCertificates.response.default.reached_core`; boolean, optional)
- `core_answer` (`listCertificates.response.default.core_answer`; string, optional)


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