---
title: "View collection private link"
method: GET
path: "/account/collections/{collection_id}/private_links/{link_id}"
tags: ["collections"]
---

# View collection private link

`GET /account/collections/{collection_id}/private_links/{link_id}`

## Request

- Base URL: `https://api.figshare.com/v2`
- URL: `https://api.figshare.com/v2/account/collections/{collection_id}/private_links/{link_id}`
- Auth: OAuth 2
  - Authorization code: `https://figshare.com/account/applications/authorize`
  - Token URL: `https://api.figshare.com/v2/token` scopes: `all`
- TypeScript: <https://skmtc.dev/figshare/apis/figshare-api/docs/account/collections/:collection_id/private_links/:link_id/get.ts> (a function with typed inputs; its response is checked against the schema)

View existing private link for this collection

## Path parameters

- `collection_id` integer, required
- `link_id` string, required

## Response `200`

OK. Collection private link

- PrivateLink
  - `id` string, required: Private link id
  - `is_active` boolean, required: True if private link is active
  - `expires_date` string, required: Date when link will expire
  - `html_location` string, url, required: HTML url for private link

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2026-03-27** `5806e3dd43b2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/figshare/apis/figshare-api/changes/account/collections/:collection_id/private_links/:link_id/get.md)

---

[API](https://skmtc.dev/figshare/apis/figshare-api.md) - [All operations](https://skmtc.dev/figshare/apis/figshare-api/llms.txt) - [OpenAPI document](https://skmtc.dev/figshare/apis/figshare-api/revisions/9dfb419f4430?raw)