---
title: "Portfolio summary PDF for a list"
method: POST
path: "/lists/{id}/portfolio-summary.pdf"
tags: ["Lists"]
---

# Portfolio summary PDF for a list

`POST /lists/{id}/portfolio-summary.pdf`

## Request

- Base URL: `https://api.companystack.co.uk`
- URL: `https://api.companystack.co.uk/lists/{id}/portfolio-summary.pdf`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

Every company on the list on one sheet (up to 150; a bigger list shows the ones needing the most attention): health grade, risk, net assets and their change, overdue filings, red flags and what changed since the list's previous summary, then the detail for the companies that need a look. Web-app Pro and Team; not counted against the report allowance. Also included at the top of the reports.zip pack.

## Path parameters

- `id` integer, required

## Response `200`

The PDF. X-Document-Reference carries its CSP- reference, checkable at /verify/{reference}.

## Other responses

- `401`: API key missing, malformed or revoked
- `403`: Plan limit or feature not included
- `429`: Fair use (`code: fair_use_limit`): portfolio summaries are limited to 30 an hour and 100 a day for each account. A refused call is not counted; `Retry-After` says when to try again. A 429 with `code: rate_limited` is the request quota.

---

[API](https://skmtc.dev/companystack/apis/companystack-api.md) · [All operations](https://skmtc.dev/companystack/apis/companystack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/companystack/apis/companystack-api/revisions/8f3234237d2d?raw)