subscriptions
subscriptions

get/api/projects/{project_id}/subscriptions/

Request

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

created_bystring

Filter by creator user UUID.

dashboardinteger

Filter by dashboard ID.

dashboard_tilesinteger

Filter to subscriptions on insights that are tiles of the given dashboard ID.

insightinteger

Filter by insight ID.

insightsstring

Filter by a comma-separated list of insight IDs.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

resource_type'ai_prompt' | 'dashboard' | 'insight'

Filter by subscription resource: insight, dashboard export, or AI report.

searchstring

A search term.

target_type'email' | 'slack' | 'teams'

Filter by delivery channel: email, Slack, or Microsoft Teams.

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.