Skip to content
PostyAPIv0.3.81
Menu

API reference

Comments

List post comments

get/v1/posts/{postId}/comments

List visible collaboration comments on a Posty post using its post ID and optional cursor pagination. Returns Posty review discussions, filtered by caller visibility, rather than comments on a published social-platform post.

Path parameters

  • postIdstringrequired

Query parameters

  • limitinteger

    Default 20 · Min 1 · Max 100

  • starting_afterstring
  • ending_beforestring

Response 200

List of comments

  • objectstringrequired

    One oflist

  • dataarray of Commentrequired
  • has_morebooleanrequired
  • next_cursorstringrequirednullable

Errors

401
Unauthenticated
403
Missing scope
404
Post not found
Request
curl "https://api.posty.social/v1/posts/$POST_ID/comments" \
  -H "Authorization: Bearer $POSTY_API_KEY"
Response 200
{
  "object": "list",
  "data": [
    {
      "id": "string",
      "postId": "string",
      "body": "string",
      "isChangeRequest": true,
      "visibility": "team",
      "createdBy": "string",
      "createdAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Create post comment

post/v1/posts/{postId}/comments

Add a collaboration comment to a Posty post using its post ID and a comment body. Returns the created comment, attributed to the authenticated caller and shared with team members or clients according to post visibility. Mentions can generate notifications. The optional isChangeRequest flag labels feedback without changing post status. This does not publish a comment to a social platform.

Path parameters

  • postIdstringrequired

Request body

  • bodystringrequired

    Min length 1 · Max length 10000

  • isChangeRequestboolean

Response 201

Comment created

  • idstringrequired
  • postIdstringrequired
  • bodystringrequired
  • isChangeRequestbooleanrequired
  • visibilitystringrequired

    One ofteamall

  • createdBystringrequirednullable
  • createdAtstring (date-time)required

Errors

401
Unauthenticated
403
Missing scope
404
Post not found
Request
curl -X POST "https://api.posty.social/v1/posts/$POST_ID/comments" \
  -H "Authorization: Bearer $POSTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string",
  "isChangeRequest": true
}'
Response 201
{
  "id": "string",
  "postId": "string",
  "body": "string",
  "isChangeRequest": true,
  "visibility": "team",
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00.000Z"
}

Delete post comment

del/v1/posts/{postId}/comments/{id}

Permanently delete a collaboration comment using its post and comment IDs in the selected workspace. Requires comment ownership or deletion permission. Removes the comment from the shared Posty discussion and returns a deletion confirmation.

Path parameters

  • postIdstringrequired
  • idstringrequired

Response 204

Deleted

Errors

401
Unauthenticated
403
Missing scope
404
Not found
Request
curl -X DELETE "https://api.posty.social/v1/posts/$POST_ID/comments/$ID" \
  -H "Authorization: Bearer $POSTY_API_KEY"
Response 204
No content

Models

Objects referenced by the endpoints above.

Comment

  • idstringrequired
  • postIdstringrequired
  • bodystringrequired
  • isChangeRequestbooleanrequired
  • visibilitystringrequired

    One ofteamall

  • createdBystringrequirednullable
  • createdAtstring (date-time)required