COcontentstudio
🔗 Share Links

List shareable links

Changed on

Retrieve the workspace's planner share links, newest first. Neither the link password nor its external-approval tokens are ever returned.

get/api/v1/workspaces/{workspace_id}/share-links

Request

  • Base URL
    https://api.contentstudio.io
  • URL
    https://api.contentstudio.io/api/v1/workspaces/{workspace_id}/share-links
  • Auth
    API key in header X-API-Key

Path parameters

workspace_idstring required
Example:610a1e660cb41530ca40d372

Query parameters

pageinteger
Example:1
per_pageinteger
Example:10

Max 100.

searchstring
Example:recap

Case-insensitive match on the link name.

Response

Share links retrieved

statusboolean
messagestring
current_pageinteger
per_pageinteger
totalinteger
last_pageinteger
frominteger nullable
tointeger nullable

Example response

{
  "status": true,
  "message": "Shareable links retrieved successfully.",
  "current_page": 1,
  "per_page": 10,
  "total": 3,
  "last_page": 1,
  "from": 1,
  "to": 3,
  "data": [
    {
      "id": "66a1f2e4c8b9a1234567890b",
      "_id": "66a1f2e4c8b9a1234567890b",
      "name": "Q1 Client Recap",
      "link_id": "q1-client-recap-a1b2c3",
      "url": "https://app.contentstudio.io/share/planner/q1-client-recap-a1b2c3",
      "scope": "selection",
      "view": "list",
      "allow_external_comments": true,
      "approval_emails": [],
      "created_at": "2026-09-02T10:00:00+00:00",
      "updated_at": "2026-09-02T10:00:00+00:00"
    }
  ]
}

Changes