---
title: "Pages a portfolio's events."
---

> 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 customer API › portfolio

`GET /v1/stores/{store}/products/{product}/portfolio/events`

## Authentication

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

## Path parameters

- `store` (`listPortfolioEvents.path.store`; string, required) — A hostname of the store.
- `product` (`listPortfolioEvents.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

- `preview` (`listPortfolioEvents.query.preview`; string, optional) — A token a seller made for the product's page or one of its entries, which opens an unpublished product's portfolio, gated as ever.
  - minLength 1; maxLength 128
- `filter` (`listPortfolioEvents.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listPortfolioEvents.query.sort`; string, optional)
  - one of `"occurred"`
- `direction` (`listPortfolioEvents.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listPortfolioEvents.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listPortfolioEvents.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listPortfolioEvents.query.count`; boolean, optional)
- `search` (`listPortfolioEvents.query.search`; string, optional)
  - minLength 1; maxLength 200

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages a portfolio's events.

#### Example

```json
{
  "total": 0,
  "items": [
    {
      "id": "string",
      "symbol": "string",
      "type": "string",
      "shares": 0,
      "price": 0,
      "amount": 0,
      "note": "string",
      "effective_date": "string",
      "symbol_type": "string",
      "currency": "string",
      "exponent": 0,
      "price_currency": "string",
      "price_exponent": 0,
      "allocation": 0,
      "allocation_change": 0,
      "ratio": {
        "num": 0,
        "den": 0
      },
      "split_kind": "string",
      "files": [
        {
          "id": "string",
          "name": "string",
          "ext": "string",
          "link": true,
          "mime": "string",
          "bytes": 0,
          "description": "string",
          "attachment_id": "string"
        }
      ],
      "occurred_at": "string"
    }
  ],
  "cursor": "string"
}
```

- `items` (`listPortfolioEvents.response.200.items`; array<object>, required)
  - `id` (`listPortfolioEvents.response.200.items.id`; string, required)
  - `symbol` (`listPortfolioEvents.response.200.items.symbol`; any of, required)
    - any of: `string`, `null`
  - `type` (`listPortfolioEvents.response.200.items.type`; string, required)
  - `shares` (`listPortfolioEvents.response.200.items.shares`; any of, required)
    - any of: `number`, `null`
  - `price` (`listPortfolioEvents.response.200.items.price`; any of, required)
    - any of: `number`, `null`
  - `amount` (`listPortfolioEvents.response.200.items.amount`; any of, required)
    - any of: `number`, `null`
  - `note` (`listPortfolioEvents.response.200.items.note`; any of, required)
    - any of: `string`, `null`
  - `effective_date` (`listPortfolioEvents.response.200.items.effective_date`; any of, required)
    - any of: `string`, `null`
  - `symbol_type` (`listPortfolioEvents.response.200.items.symbol_type`; any of, required)
    - any of: `string`, `null`
  - `currency` (`listPortfolioEvents.response.200.items.currency`; string, required)
  - `exponent` (`listPortfolioEvents.response.200.items.exponent`; any of, required)
    - any of: `number`, `null`
  - `price_currency` (`listPortfolioEvents.response.200.items.price_currency`; string, required)
  - `price_exponent` (`listPortfolioEvents.response.200.items.price_exponent`; any of, required)
    - any of: `number`, `null`
  - `allocation` (`listPortfolioEvents.response.200.items.allocation`; any of, required)
    - any of: `number`, `null`
  - `allocation_change` (`listPortfolioEvents.response.200.items.allocation_change`; any of, required)
    - any of: `number`, `null`
  - `ratio` (`listPortfolioEvents.response.200.items.ratio`; any of, required)
    - any of: `object`, `null`
  - `split_kind` (`listPortfolioEvents.response.200.items.split_kind`; any of, required) — How a split moved the shares, which its ratio alone cannot tell apart; null for any other event.
    - any of: `string`, `null`
  - `files` (`listPortfolioEvents.response.200.items.files`; any of, required)
    - any of: `array<object>`, `null`
  - `occurred_at` (`listPortfolioEvents.response.200.items.occurred_at`; any of, required)
    - any of: `string`, `null`
- `cursor` (`listPortfolioEvents.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listPortfolioEvents.response.200.total`; number, optional)

### default

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

#### Example

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

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


Source: https://docs.sherpo.io/customer-api/reference/list-portfolio-events/index.md
