PostHog Dashboards API
The dashboards API from PostHog — 40 operation(s) for dashboards.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/posthog-dashboards-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: PostHog Dashboards API
version: 1.0.0
description: ''
tags:
- name: Dashboards
paths:
/api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/:
get:
operationId: environments_dashboards_collaborators_list
parameters:
- in: path
name: dashboard_id
schema:
type: integer
required: true
- $ref: '#/components/parameters/EnvironmentIdPath'
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- dashboard:read
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DashboardCollaborator'
description: ''
deprecated: true
x-explicit-tags: []
summary: Environments dashboards collaborators list
x-summary-source: derived
post:
operationId: environments_dashboards_collaborators_create
parameters:
- in: path
name: dashboard_id
schema:
type: integer
required: true
- $ref: '#/components/parameters/EnvironmentIdPath'
tags:
- Dashboards
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardCollaborator'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DashboardCollaborator'
multipart/form-data:
schema:
$ref: '#/components/schemas/DashboardCollaborator'
required: true
security:
- PersonalAPIKeyAuth:
- dashboard:write
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardCollaborator'
description: ''
deprecated: true
x-explicit-tags: []
summary: Environments dashboards collaborators create
x-summary-source: derived
/api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/:
delete:
operationId: environments_dashboards_collaborators_destroy
parameters:
- in: path
name: dashboard_id
schema:
type: integer
required: true
- $ref: '#/components/parameters/EnvironmentIdPath'
- in: path
name: user__uuid
schema:
type: string
format: uuid
required: true
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- dashboard:write
responses:
'204':
description: No response body
deprecated: true
x-explicit-tags: []
summary: Environments dashboards collaborators destroy
x-summary-source: derived
/api/environments/{environment_id}/data_color_themes/:
get:
operationId: environments_data_color_themes_list
parameters:
- $ref: '#/components/parameters/EnvironmentIdPath'
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- project:read
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedDataColorThemeList'
description: ''
deprecated: true
x-explicit-tags:
- dashboards
summary: Environments data color themes list
x-summary-source: derived
post:
operationId: environments_data_color_themes_create
parameters:
- $ref: '#/components/parameters/EnvironmentIdPath'
tags:
- Dashboards
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DataColorTheme'
multipart/form-data:
schema:
$ref: '#/components/schemas/DataColorTheme'
required: true
security:
- PersonalAPIKeyAuth:
- project:write
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
description: ''
deprecated: true
x-explicit-tags:
- dashboards
summary: Environments data color themes create
x-summary-source: derived
/api/environments/{environment_id}/data_color_themes/{id}/:
get:
operationId: environments_data_color_themes_retrieve
parameters:
- $ref: '#/components/parameters/EnvironmentIdPath'
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this data color theme.
required: true
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- project:read
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
description: ''
deprecated: true
x-explicit-tags:
- dashboards
summary: Environments data color themes retrieve
x-summary-source: derived
put:
operationId: environments_data_color_themes_update
parameters:
- $ref: '#/components/parameters/EnvironmentIdPath'
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this data color theme.
required: true
tags:
- Dashboards
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DataColorTheme'
multipart/form-data:
schema:
$ref: '#/components/schemas/DataColorTheme'
required: true
security:
- PersonalAPIKeyAuth:
- project:write
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
description: ''
deprecated: true
x-explicit-tags:
- dashboards
summary: Environments data color themes update
x-summary-source: derived
patch:
operationId: environments_data_color_themes_partial_update
parameters:
- $ref: '#/components/parameters/EnvironmentIdPath'
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this data color theme.
required: true
tags:
- Dashboards
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDataColorTheme'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDataColorTheme'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDataColorTheme'
security:
- PersonalAPIKeyAuth:
- project:write
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
description: ''
deprecated: true
x-explicit-tags:
- dashboards
summary: Environments data color themes partial update
x-summary-source: derived
delete:
operationId: environments_data_color_themes_destroy
parameters:
- $ref: '#/components/parameters/EnvironmentIdPath'
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this data color theme.
required: true
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- project:write
responses:
'204':
description: No response body
deprecated: true
x-explicit-tags:
- dashboards
summary: Environments data color themes destroy
x-summary-source: derived
/api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/:
get:
operationId: dashboards_collaborators_list
parameters:
- in: path
name: dashboard_id
schema:
type: integer
required: true
- $ref: '#/components/parameters/ProjectIdPath'
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- dashboard:read
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DashboardCollaborator'
description: ''
x-explicit-tags: []
summary: Dashboards collaborators list
x-summary-source: derived
post:
operationId: dashboards_collaborators_create
parameters:
- in: path
name: dashboard_id
schema:
type: integer
required: true
- $ref: '#/components/parameters/ProjectIdPath'
tags:
- Dashboards
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardCollaborator'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DashboardCollaborator'
multipart/form-data:
schema:
$ref: '#/components/schemas/DashboardCollaborator'
required: true
security:
- PersonalAPIKeyAuth:
- dashboard:write
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardCollaborator'
description: ''
x-explicit-tags: []
summary: Dashboards collaborators create
x-summary-source: derived
/api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/:
delete:
operationId: dashboards_collaborators_destroy
parameters:
- in: path
name: dashboard_id
schema:
type: integer
required: true
- $ref: '#/components/parameters/ProjectIdPath'
- in: path
name: user__uuid
schema:
type: string
format: uuid
required: true
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- dashboard:write
responses:
'204':
description: No response body
x-explicit-tags: []
summary: Dashboards collaborators destroy
x-summary-source: derived
/api/projects/{project_id}/data_color_themes/:
get:
operationId: data_color_themes_list
parameters:
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- $ref: '#/components/parameters/ProjectIdPath'
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- project:read
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedDataColorThemeList'
description: ''
x-explicit-tags:
- dashboards
summary: Data color themes list
x-summary-source: derived
post:
operationId: data_color_themes_create
parameters:
- $ref: '#/components/parameters/ProjectIdPath'
tags:
- Dashboards
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DataColorTheme'
multipart/form-data:
schema:
$ref: '#/components/schemas/DataColorTheme'
required: true
security:
- PersonalAPIKeyAuth:
- project:write
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
description: ''
x-explicit-tags:
- dashboards
summary: Data color themes create
x-summary-source: derived
/api/projects/{project_id}/data_color_themes/{id}/:
get:
operationId: data_color_themes_retrieve
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this data color theme.
required: true
- $ref: '#/components/parameters/ProjectIdPath'
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- project:read
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
description: ''
x-explicit-tags:
- dashboards
summary: Data color themes retrieve
x-summary-source: derived
put:
operationId: data_color_themes_update
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this data color theme.
required: true
- $ref: '#/components/parameters/ProjectIdPath'
tags:
- Dashboards
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DataColorTheme'
multipart/form-data:
schema:
$ref: '#/components/schemas/DataColorTheme'
required: true
security:
- PersonalAPIKeyAuth:
- project:write
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
description: ''
x-explicit-tags:
- dashboards
summary: Data color themes update
x-summary-source: derived
patch:
operationId: data_color_themes_partial_update
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this data color theme.
required: true
- $ref: '#/components/parameters/ProjectIdPath'
tags:
- Dashboards
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDataColorTheme'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDataColorTheme'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDataColorTheme'
security:
- PersonalAPIKeyAuth:
- project:write
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataColorTheme'
description: ''
x-explicit-tags:
- dashboards
summary: Data color themes partial update
x-summary-source: derived
delete:
operationId: data_color_themes_destroy
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this data color theme.
required: true
- $ref: '#/components/parameters/ProjectIdPath'
tags:
- Dashboards
security:
- PersonalAPIKeyAuth:
- project:write
responses:
'204':
description: No response body
x-explicit-tags:
- dashboards
summary: Data color themes destroy
x-summary-source: derived
components:
schemas:
NullEnum:
enum:
- null
DataColorTheme:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 100
colors: {}
is_global:
type: boolean
readOnly: true
created_at:
type:
- string
- 'null'
format: date-time
readOnly: true
created_by:
allOf:
- $ref: '#/components/schemas/UserBasic'
readOnly: true
required:
- created_at
- created_by
- id
- is_global
- name
PatchedDataColorTheme:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 100
colors: {}
is_global:
type: boolean
readOnly: true
created_at:
type:
- string
- 'null'
format: date-time
readOnly: true
created_by:
allOf:
- $ref: '#/components/schemas/UserBasic'
readOnly: true
UserBasic:
type: object
properties:
id:
type: integer
readOnly: true
uuid:
type: string
format: uuid
readOnly: true
distinct_id:
type:
- string
- 'null'
maxLength: 200
first_name:
type: string
maxLength: 150
last_name:
type: string
maxLength: 150
email:
type: string
format: email
title: Email address
maxLength: 254
is_email_verified:
type:
- boolean
- 'null'
hedgehog_config:
type:
- object
- 'null'
additionalProperties: true
readOnly: true
role_at_organization:
oneOf:
- $ref: '#/components/schemas/RoleAtOrganizationEnum'
- $ref: '#/components/schemas/BlankEnum'
- $ref: '#/components/schemas/NullEnum'
required:
- email
- hedgehog_config
- id
- uuid
BlankEnum:
enum:
- ''
RestrictionLevelEnum:
enum:
- 21
- 37
type: integer
description: '* `21` - Everyone in the project can edit
* `37` - Only those invited to this dashboard can edit'
PaginatedDataColorThemeList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type:
- string
- 'null'
format: uri
example: http://api.example.org/accounts/?offset=400&limit=100
previous:
type:
- string
- 'null'
format: uri
example: http://api.example.org/accounts/?offset=200&limit=100
results:
type: array
items:
$ref: '#/components/schemas/DataColorTheme'
RoleAtOrganizationEnum:
enum:
- engineering
- data
- product
- founder
- leadership
- marketing
- sales
- other
type: string
description: '* `engineering` - Engineering
* `data` - Data
* `product` - Product Management
* `founder` - Founder
* `leadership` - Leadership
* `marketing` - Marketing
* `sales` - Sales / Success
* `other` - Other'
DashboardCollaborator:
type: object
properties:
id:
type: string
format: uuid
readOnly: true
dashboard_id:
type: integer
readOnly: true
user:
allOf:
- $ref: '#/components/schemas/UserBasic'
readOnly: true
level:
$ref: '#/components/schemas/RestrictionLevelEnum'
added_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
user_uuid:
type: string
format: uuid
writeOnly: true
required:
- added_at
- dashboard_id
- id
- level
- updated_at
- user
- user_uuid
parameters:
EnvironmentIdPath:
in: path
name: environment_id
required: true
schema:
type: string
description: Deprecated. Use /api/projects/{project_id}/ instead.
ProjectIdPath:
in: path
name: project_id
required: true
schema:
type: string
description: Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
securitySchemes:
PersonalAPIKeyAuth:
type: http
scheme: bearer
x-tagGroups:
- name: All endpoints
tags:
- LLM Analytics
- actions
- activity_log
- activity_logs
- advanced_activity_logs
- alerts
- annotations
- approval_policies
- batch_exports
- cdp
- change_requests
- code
- code-invites
- cohorts
- comments
- conversations
- core
- customer_analytics
- customer_journeys
- customer_profile_configs
- dashboard_templates
- dashboards
- data_color_themes
- data_modeling_jobs
- data_warehouse
- dataset_items
- datasets
- desktop_recordings
- domains
- early_access_feature
- early_access_features
- elements
- endpoints
- environments
- error_tracking
- evaluation_runs
- evaluations
- event_definitions
- event_filter
- event_schemas
- events
- experiment_holdouts
- experiment_saved_metrics
- experiments
- exports
- external_data_schemas
- external_data_sources
- feature_flags
- file_system
- file_system_shortcut
- flag_value
- groups
- groups_types
- health_issues
- heatmap_screenshots
- heatmaps
- hog_flows
- hog_function_templates
- hog_functions
- insight_variables
- insights
- integrations
- invites
- js-snippet
- legal_documents
- lineage
- live_debugger_breakpoints
- llm_analytics
- llm_prompts
- llm_skills
- logs
- managed_viewsets
- max
- max_tools
- mcp_server_installations
- mcp_servers
- mcp_store
- mcp_tools
- members
- notebooks
- oauth_applications
- object_media_previews
- organizations
- persisted_folder
- persons
- platform_features
- plugin_configs
- product_analytics
- product_tours
- project_secret_api_keys
- projects
- property_definitions
- proxy_records
- public_hog_function_templates
- query
- replay
- reverse_proxy
- role_external_references
- roles
- sandbox-environments
- sandbox_environments
- saved
- schema_property_groups
- sdk_doctor
- session_group_summaries
- session_recording_playlists
- session_recordings
- session_summaries
- sessions
- signals
- subscriptions
- surveys
- taggers
- task-automations
- task-runs
- task_automations
- tasks
- uploaded_media
- user_home_settings
- user_interviews
- users
- visual_review
- warehouse_dag
- warehouse_model_paths
- warehouse_saved_queries
- warehouse_saved_query_folders
- warehouse_tables
- warehouse_view_link
- warehouse_view_links
- web_analytics
- web_experiments
- web_vitals
- welcome
- workflows