---
title: "List portfolios allocations"
method: GET
path: "/portfolios/allocations"
tags: ["Portfolios"]
---

# List portfolios allocations

`GET /portfolios/allocations`

List portfolios allocations

## Query parameters

- `sort` 'id'
- `order` 'ASC'
- `offset` integer
- `limit` integer
- `start_date` string
- `end_date` string
- `instrument_ids` string

## Response `200`

Portfolios allocations

- object
  - `meta` object, required
    - `offset` integer, required — Amount of resource to offset in the response.
    - `limit` integer, required — Total limit of the response.
    - `count` integer, required — Count of the resources returned in the response.
    - `total_count` integer, required — Total count of all the resources.
    - `sort` string — The field that the list is sorted by.
    - `order` 'ASC' | 'DESC' — The ordering of the response. * ASC - Ascending order * DESC - Descending order
  - `data` object[], required
    - `id` string, uuid, required
    - `created_at` string, date-time, required — Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `updated_at` string, date-time, required — Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
    - `name` string, required — Allocation name
    - `allocation` object[], required — List of portfolios allocations
      - `instrument_id` union, required
        - string — International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number).
        - string, uuid — UPVEST instrument identifier
      - `instrument_id_type` 'ISIN' | 'UPVEST', required — The type of the ID used in the request. * ISIN - International Securities Identification Number * UPVEST - UPVEST's unique instrument identifier
      - `weight` string, required — Instrument allocation weight

## Other responses

- `400` — Bad Request. The incoming request had a malformed parameter/object.
- `401` — Unauthorized. The caller has not been authenticated.
- `403` — Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `404` — Not Found. The requested resource could not be found.
- `405` — Method Not Allowed. The requested method is not allowed on the requested resource.
- `406` — Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `429` — Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500` — Internal Server Error. The service encountered an unexpected error.
- `503` — Service Unavailable. The service handling for this request cannot be reached at this time.
- `504` — Gateway Timeout. The service gateway has reached its internal timeout.

---

[API](https://skmtc.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/eb94c0091916/schema)