Skip to content
PostyAPIv0.3.81
Menu

API reference

Client shares

List client shares

get/v1/client-shares

List the workspace's client review links (workspace, post or campaign scoped) without their tokens. Revoked links are left out unless includeRevoked is true. Needs campaigns:update.

Query parameters

  • includeRevokedstring

    One oftruefalse

Response 200

Client share links

  • dataarray of objectrequired
    Child attributes
    • idstringrequired
    • workspaceIdstringrequired
    • scopestringrequired

      One ofworkspacepostcampaign

    • subjectIdsarray of stringrequirednullable
    • labelstringrequirednullable
    • emailstringrequirednullable
    • expiresAtstring (date-time)requirednullable
    • revokedAtstring (date-time)requirednullable
    • lastUsedAtstring (date-time)requirednullable
    • createdBystringrequirednullable
    • createdAtstring (date-time)required
    • revokedbooleanrequired
    • expiredbooleanrequired

Errors

401
Unauthenticated
403
Missing scope
Request
curl "https://api.posty.social/v1/client-shares" \
  -H "Authorization: Bearer $POSTY_API_KEY"
Response 200
{
  "data": [
    {
      "id": "string",
      "workspaceId": "string",
      "scope": "workspace",
      "subjectIds": [
        "string"
      ],
      "label": "string",
      "email": "string",
      "expiresAt": "2026-01-15T09:30:00.000Z",
      "revokedAt": "2026-01-15T09:30:00.000Z",
      "lastUsedAt": "2026-01-15T09:30:00.000Z",
      "createdBy": "string",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "revoked": true,
      "expired": true
    }
  ]
}

Create client share

post/v1/client-shares

Create a public review link that lets anyone holding it read client-visible posts: the whole workspace, the posts in subjectIds (scope post) or one campaign's deliverables and brief (scope campaign, agency organizations only). The url and token are returned only in this response. Needs campaigns:update; sends no email.

Request body

  • scopestringrequired

    One ofworkspacepostcampaign

  • subjectIdsarray of string

    Max items 100

  • labelstring

    Max length 200

  • emailstring

    Max length 320

  • expiresAtstring (date-time)nullable

Response 201

Link created; store the url now, it cannot be shown again

  • idstringrequired
  • workspaceIdstringrequired
  • scopestringrequired

    One ofworkspacepostcampaign

  • subjectIdsarray of stringrequirednullable
  • labelstringrequirednullable
  • emailstringrequirednullable
  • expiresAtstring (date-time)requirednullable
  • revokedAtstring (date-time)requirednullable
  • lastUsedAtstring (date-time)requirednullable
  • createdBystringrequirednullable
  • createdAtstring (date-time)required
  • revokedbooleanrequired
  • expiredbooleanrequired
  • tokenstringrequired
  • urlstringrequired

Errors

400
Invalid request
401
Unauthenticated
403
Missing scope
404
Workspace not found
Request
curl -X POST "https://api.posty.social/v1/client-shares" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "scope": "workspace",
  "subjectIds": [
    "string"
  ],
  "label": "string",
  "email": "string",
  "expiresAt": "2026-01-15T09:30:00.000Z"
}'
Response 201
{
  "id": "string",
  "workspaceId": "string",
  "scope": "workspace",
  "subjectIds": [
    "string"
  ],
  "label": "string",
  "email": "string",
  "expiresAt": "2026-01-15T09:30:00.000Z",
  "revokedAt": "2026-01-15T09:30:00.000Z",
  "lastUsedAt": "2026-01-15T09:30:00.000Z",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "revoked": true,
  "expired": true,
  "token": "string",
  "url": "string"
}

Revoke client share

del/v1/client-shares/{id}

Revoke a client review link so it stops working at once. Revoking cannot be undone; issue a new link instead. Needs campaigns:update.

Path parameters

  • idstringrequired

Response 204

Link revoked

Errors

401
Unauthenticated
403
Missing scope
404
Link not found or already revoked
Request
curl -X DELETE "https://api.posty.social/v1/client-shares/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY"
Response 204
No content