comments

get/api/projects/{project_id}/comments/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/comments/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

completed'any' | 'open' | 'completed'

When kind=task, restrict to open (incomplete) or completed tasks. Ignored when kind is not 'task'. Defaults to 'any' (no filter).

  • any - any
  • open - open
  • completed - completed
created_byinteger

Filter by the numeric ID of the user who wrote the comment.

cursorstring

The pagination cursor value.

item_idstring

Filter by the ID of the resource being commented on.

kind'any' | 'comment' | 'task'

Filter by comment kind. 'task' returns only items intentionally created as actionable. 'comment' excludes tasks. Defaults to 'any' (no filter).

  • any - any
  • comment - comment
  • task - task
scopestring

Filter by resource type (e.g. Dashboard, FeatureFlag, Insight, Replay). Support-ticket scopes (Ticket, conversations_ticket) additionally require ticket API scope access.

searchstring

Full-text search within comment content.

source_commentstring

Filter replies to a specific parent comment.

task_idstring uuid

Owning task for task, task_artifact, task_preview, task_browser, and canvas comment scopes.

Response

nextstring uri nullable
previousstring uri nullable

Example response

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
}

Changes

No recorded changes to this operation across all 1 revision of this API.