---
title: "List pins"
method: POST
path: "/pins.list"
tags: ["Pins"]
---

# List pins

`POST /pins.list`

## Request

- Base URL: `https://app.getoutline.com/api`
- URL: `https://app.getoutline.com/api/pins.list`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://app.getoutline.com/oauth/authorize`
    - Token URL: `https://app.getoutline.com/oauth/token` scopes: `read`, `write`

List the pinned documents for a collection, or for the home screen when no `collectionId` is provided.

## Request body

- object
  - `offset` number
  - `limit` number
  - `collectionId` string, uuid, nullable: The collection to list pins for. Omit to list home screen pins.

## Response `200`

OK

- object
  - `data` Pin[]
    - `id` string, uuid: Unique identifier for the object.
    - `documentId` string, uuid: Identifier for the pinned document.
    - `collectionId` string, uuid, nullable: Identifier for the collection the document is pinned to. When `null` the document is pinned to the home screen.
    - `index` string: The position of the pin, used for ordering.
    - `createdAt` string, date-time: Date and time when this pin was created.
    - `updatedAt` string, date-time: Date and time when this pin was last updated.
  - `pagination` Pagination
    - `offset` number
    - `limit` number
  - `policies` Policy[]
    - `id` string, uuid: Unique identifier for the object this policy references.
    - `abilities` object: The abilities that are allowed by this policy, if an array is returned then the individual ID's in the array represent the memberships that grant the ability.

## Other responses

- `401`: The API key is missing or otherwise invalid.
- `403`: The current API key is not authorized to perform this action.
- `429`: The request was rate limited.

## Changes

- **2026-09-05** `6287bce7caad`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/defaulr/apis/outline-api/changes/pins.list/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) - [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/defaulr/apis/outline-api/revisions/5ddf01ffba84?raw)