field_notes

Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.

get/api/projects/{project_id}/field_notes/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/field_notes/
  • 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

field_note_status'acknowledged' | 'dismissed' | 'pending' | 'resolved'

Filter to field notes in this lifecycle state (e.g. pending for unaddressed feedback).

hoststring

Filter to field notes made on this hostname (e.g. app.example.com).

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

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