openapi: 3.0.3 info: title: PostHog actions warehouse_tables API version: 1.0.0 description: '' tags: - name: warehouse_tables paths: /api/environments/{environment_id}/warehouse_tables/: get: operationId: environments_warehouse_tables_list description: Create, Read, Update and Delete Warehouse Tables. 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 - name: search required: false in: query description: A search term. schema: type: string tags: - warehouse_tables security: - PersonalAPIKeyAuth: - warehouse_table:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTableList' description: '' deprecated: true x-explicit-tags: - data_warehouse post: operationId: environments_warehouse_tables_create description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' multipart/form-data: schema: $ref: '#/components/schemas/Table' required: true security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '201': content: application/json: schema: $ref: '#/components/schemas/Table' description: '' deprecated: true x-explicit-tags: - data_warehouse /api/environments/{environment_id}/warehouse_tables/{id}/: get: operationId: environments_warehouse_tables_retrieve description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true tags: - warehouse_tables security: - PersonalAPIKeyAuth: - warehouse_table:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/Table' description: '' deprecated: true x-explicit-tags: [] put: operationId: environments_warehouse_tables_update description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' multipart/form-data: schema: $ref: '#/components/schemas/Table' required: true security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/Table' description: '' deprecated: true x-explicit-tags: [] patch: operationId: environments_warehouse_tables_partial_update description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTable' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTable' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTable' security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/Table' description: '' deprecated: true x-explicit-tags: [] delete: operationId: environments_warehouse_tables_destroy description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true tags: - warehouse_tables security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '204': description: No response body deprecated: true x-explicit-tags: [] /api/environments/{environment_id}/warehouse_tables/{id}/refresh_schema/: post: operationId: environments_warehouse_tables_refresh_schema_create description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' multipart/form-data: schema: $ref: '#/components/schemas/Table' required: true responses: '200': description: No response body deprecated: true x-explicit-tags: [] /api/environments/{environment_id}/warehouse_tables/{id}/update_schema/: post: operationId: environments_warehouse_tables_update_schema_create description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' multipart/form-data: schema: $ref: '#/components/schemas/Table' required: true responses: '200': description: No response body deprecated: true x-explicit-tags: [] /api/environments/{environment_id}/warehouse_tables/file/: post: operationId: environments_warehouse_tables_file_create description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' tags: - warehouse_tables requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' required: true security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '200': description: No response body deprecated: true x-explicit-tags: - data_warehouse /api/projects/{project_id}/warehouse_tables/: get: operationId: warehouse_tables_list description: Create, Read, Update and Delete Warehouse Tables. 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' - name: search required: false in: query description: A search term. schema: type: string tags: - warehouse_tables security: - PersonalAPIKeyAuth: - warehouse_table:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTableList' description: '' x-explicit-tags: - data_warehouse post: operationId: warehouse_tables_create description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/ProjectIdPath' tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' multipart/form-data: schema: $ref: '#/components/schemas/Table' required: true security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '201': content: application/json: schema: $ref: '#/components/schemas/Table' description: '' x-explicit-tags: - data_warehouse /api/projects/{project_id}/warehouse_tables/{id}/: get: operationId: warehouse_tables_retrieve description: Create, Read, Update and Delete Warehouse Tables. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - warehouse_tables security: - PersonalAPIKeyAuth: - warehouse_table:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/Table' description: '' x-explicit-tags: [] put: operationId: warehouse_tables_update description: Create, Read, Update and Delete Warehouse Tables. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' multipart/form-data: schema: $ref: '#/components/schemas/Table' required: true security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/Table' description: '' x-explicit-tags: [] patch: operationId: warehouse_tables_partial_update description: Create, Read, Update and Delete Warehouse Tables. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTable' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTable' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTable' security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/Table' description: '' x-explicit-tags: [] delete: operationId: warehouse_tables_destroy description: Create, Read, Update and Delete Warehouse Tables. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - warehouse_tables security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '204': description: No response body x-explicit-tags: [] /api/projects/{project_id}/warehouse_tables/{id}/refresh_schema/: post: operationId: warehouse_tables_refresh_schema_create description: Create, Read, Update and Delete Warehouse Tables. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' multipart/form-data: schema: $ref: '#/components/schemas/Table' required: true responses: '200': description: No response body x-explicit-tags: [] /api/projects/{project_id}/warehouse_tables/{id}/update_schema/: post: operationId: warehouse_tables_update_schema_create description: Create, Read, Update and Delete Warehouse Tables. parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this data warehouse table. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - warehouse_tables requestBody: content: application/json: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' multipart/form-data: schema: $ref: '#/components/schemas/Table' required: true responses: '200': description: No response body x-explicit-tags: [] /api/projects/{project_id}/warehouse_tables/file/: post: operationId: warehouse_tables_file_create description: Create, Read, Update and Delete Warehouse Tables. parameters: - $ref: '#/components/parameters/ProjectIdPath' tags: - warehouse_tables requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Table' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Table' required: true security: - PersonalAPIKeyAuth: - warehouse_table:write responses: '200': description: No response body x-explicit-tags: - data_warehouse components: schemas: Credential: type: object properties: id: type: string format: uuid readOnly: true created_by: allOf: - $ref: '#/components/schemas/UserBasic' readOnly: true created_at: type: string format: date-time readOnly: true access_key: type: string writeOnly: true maxLength: 500 access_secret: type: string writeOnly: true maxLength: 500 required: - access_key - access_secret - created_at - created_by - id ExternalDataSourceTypeEnum: enum: - Ashby - Supabase - CustomerIO - Github - Stripe - Hubspot - Postgres - Zendesk - Snowflake - Salesforce - MySQL - MongoDB - MSSQL - Vitally - BigQuery - Chargebee - Clerk - GoogleAds - TemporalIO - DoIt - GoogleSheets - MetaAds - Klaviyo - Mailchimp - Braze - Mailjet - Redshift - Polar - RevenueCat - LinkedinAds - RedditAds - TikTokAds - BingAds - Shopify - Attio - SnapchatAds - Linear - Intercom - Amplitude - Mixpanel - Jira - ActiveCampaign - Marketo - Adjust - AppsFlyer - Freshdesk - GoogleAnalytics - Pipedrive - SendGrid - Slack - PagerDuty - Asana - Notion - Airtable - Greenhouse - BambooHR - Lever - GitLab - Datadog - Sentry - Pendo - FullStory - AmazonAds - PinterestAds - AppleSearchAds - QuickBooks - Xero - NetSuite - WooCommerce - BigCommerce - PayPal - Square - Zoom - Trello - Monday - ClickUp - Confluence - Recurly - SalesLoft - Outreach - Gong - Calendly - Typeform - Iterable - ZohoCRM - Close - Oracle - DynamoDB - Elasticsearch - Kafka - LaunchDarkly - Braintree - Recharge - HelpScout - Gorgias - Instagram - YouTubeAnalytics - FacebookPages - TwitterAds - Workday - ServiceNow - Pardot - Copper - Front - ChartMogul - Zuora - Paddle - CircleCI - CockroachDB - Firebase - AzureBlob - GoogleDrive - OneDrive - SharePoint - Box - SFTP - MicrosoftTeams - Aircall - Webflow - Okta - Auth0 - Productboard - Smartsheet - Wrike - Plaid - SurveyMonkey - Eventbrite - RingCentral - Twilio - Freshsales - Shortcut - ConvertKit - Drip - CampaignMonitor - MailerLite - Omnisend - Brevo - Postmark - Granola - BuildBetter - Convex - ClickHouse - Plain - Resend type: string description: '* `Ashby` - Ashby * `Supabase` - Supabase * `CustomerIO` - CustomerIO * `Github` - Github * `Stripe` - Stripe * `Hubspot` - Hubspot * `Postgres` - Postgres * `Zendesk` - Zendesk * `Snowflake` - Snowflake * `Salesforce` - Salesforce * `MySQL` - MySQL * `MongoDB` - MongoDB * `MSSQL` - MSSQL * `Vitally` - Vitally * `BigQuery` - BigQuery * `Chargebee` - Chargebee * `Clerk` - Clerk * `GoogleAds` - GoogleAds * `TemporalIO` - TemporalIO * `DoIt` - DoIt * `GoogleSheets` - GoogleSheets * `MetaAds` - MetaAds * `Klaviyo` - Klaviyo * `Mailchimp` - Mailchimp * `Braze` - Braze * `Mailjet` - Mailjet * `Redshift` - Redshift * `Polar` - Polar * `RevenueCat` - RevenueCat * `LinkedinAds` - LinkedinAds * `RedditAds` - RedditAds * `TikTokAds` - TikTokAds * `BingAds` - BingAds * `Shopify` - Shopify * `Attio` - Attio * `SnapchatAds` - SnapchatAds * `Linear` - Linear * `Intercom` - Intercom * `Amplitude` - Amplitude * `Mixpanel` - Mixpanel * `Jira` - Jira * `ActiveCampaign` - ActiveCampaign * `Marketo` - Marketo * `Adjust` - Adjust * `AppsFlyer` - AppsFlyer * `Freshdesk` - Freshdesk * `GoogleAnalytics` - GoogleAnalytics * `Pipedrive` - Pipedrive * `SendGrid` - SendGrid * `Slack` - Slack * `PagerDuty` - PagerDuty * `Asana` - Asana * `Notion` - Notion * `Airtable` - Airtable * `Greenhouse` - Greenhouse * `BambooHR` - BambooHR * `Lever` - Lever * `GitLab` - GitLab * `Datadog` - Datadog * `Sentry` - Sentry * `Pendo` - Pendo * `FullStory` - FullStory * `AmazonAds` - AmazonAds * `PinterestAds` - PinterestAds * `AppleSearchAds` - AppleSearchAds * `QuickBooks` - QuickBooks * `Xero` - Xero * `NetSuite` - NetSuite * `WooCommerce` - WooCommerce * `BigCommerce` - BigCommerce * `PayPal` - PayPal * `Square` - Square * `Zoom` - Zoom * `Trello` - Trello * `Monday` - Monday * `ClickUp` - ClickUp * `Confluence` - Confluence * `Recurly` - Recurly * `SalesLoft` - SalesLoft * `Outreach` - Outreach * `Gong` - Gong * `Calendly` - Calendly * `Typeform` - Typeform * `Iterable` - Iterable * `ZohoCRM` - ZohoCRM * `Close` - Close * `Oracle` - Oracle * `DynamoDB` - DynamoDB * `Elasticsearch` - Elasticsearch * `Kafka` - Kafka * `LaunchDarkly` - LaunchDarkly * `Braintree` - Braintree * `Recharge` - Recharge * `HelpScout` - HelpScout * `Gorgias` - Gorgias * `Instagram` - Instagram * `YouTubeAnalytics` - YouTubeAnalytics * `FacebookPages` - FacebookPages * `TwitterAds` - TwitterAds * `Workday` - Workday * `ServiceNow` - ServiceNow * `Pardot` - Pardot * `Copper` - Copper * `Front` - Front * `ChartMogul` - ChartMogul * `Zuora` - Zuora * `Paddle` - Paddle * `CircleCI` - CircleCI * `CockroachDB` - CockroachDB * `Firebase` - Firebase * `AzureBlob` - AzureBlob * `GoogleDrive` - GoogleDrive * `OneDrive` - OneDrive * `SharePoint` - SharePoint * `Box` - Box * `SFTP` - SFTP * `MicrosoftTeams` - MicrosoftTeams * `Aircall` - Aircall * `Webflow` - Webflow * `Okta` - Okta * `Auth0` - Auth0 * `Productboard` - Productboard * `Smartsheet` - Smartsheet * `Wrike` - Wrike * `Plaid` - Plaid * `SurveyMonkey` - SurveyMonkey * `Eventbrite` - Eventbrite * `RingCentral` - RingCentral * `Twilio` - Twilio * `Freshsales` - Freshsales * `Shortcut` - Shortcut * `ConvertKit` - ConvertKit * `Drip` - Drip * `CampaignMonitor` - CampaignMonitor * `MailerLite` - MailerLite * `Omnisend` - Omnisend * `Brevo` - Brevo * `Postmark` - Postmark * `Granola` - Granola * `BuildBetter` - BuildBetter * `Convex` - Convex * `ClickHouse` - ClickHouse * `Plain` - Plain * `Resend` - Resend' SimpleExternalDataSourceSerializers: type: object properties: id: type: string format: uuid readOnly: true created_at: type: string format: date-time readOnly: true created_by: type: integer readOnly: true nullable: true status: type: string readOnly: true source_type: allOf: - $ref: '#/components/schemas/ExternalDataSourceTypeEnum' readOnly: true required: - created_at - created_by - id - source_type - status BlankEnum: enum: - '' TableFormatEnum: enum: - CSV - CSVWithNames - Parquet - JSONEachRow - Delta - DeltaS3Wrapper type: string description: '* `CSV` - CSV * `CSVWithNames` - CSVWithNames * `Parquet` - Parquet * `JSONEachRow` - JSON * `Delta` - Delta * `DeltaS3Wrapper` - DeltaS3Wrapper' UserBasic: type: object properties: id: type: integer readOnly: true uuid: type: string format: uuid readOnly: true distinct_id: type: string nullable: true 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 nullable: true hedgehog_config: type: object additionalProperties: true nullable: true readOnly: true role_at_organization: nullable: true oneOf: - $ref: '#/components/schemas/RoleAtOrganizationEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - email - hedgehog_config - id - uuid Table: type: object description: Mixin for serializers to add user access control fields properties: id: type: string format: uuid readOnly: true deleted: type: boolean nullable: true name: type: string maxLength: 128 format: $ref: '#/components/schemas/TableFormatEnum' created_by: allOf: - $ref: '#/components/schemas/UserBasic' readOnly: true created_at: type: string format: date-time readOnly: true url_pattern: type: string maxLength: 500 credential: $ref: '#/components/schemas/Credential' columns: type: array items: type: object additionalProperties: true readOnly: true external_data_source: allOf: - $ref: '#/components/schemas/SimpleExternalDataSourceSerializers' readOnly: true external_schema: type: object additionalProperties: true nullable: true readOnly: true options: type: object additionalProperties: true user_access_level: type: string nullable: true readOnly: true description: The effective access level the user has for this object required: - columns - created_at - created_by - credential - external_data_source - external_schema - format - id - name - url_pattern - user_access_level 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' PaginatedTableList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Table' PatchedTable: type: object description: Mixin for serializers to add user access control fields properties: id: type: string format: uuid readOnly: true deleted: type: boolean nullable: true name: type: string maxLength: 128 format: $ref: '#/components/schemas/TableFormatEnum' created_by: allOf: - $ref: '#/components/schemas/UserBasic' readOnly: true created_at: type: string format: date-time readOnly: true url_pattern: type: string maxLength: 500 credential: $ref: '#/components/schemas/Credential' columns: type: array items: type: object additionalProperties: true readOnly: true external_data_source: allOf: - $ref: '#/components/schemas/SimpleExternalDataSourceSerializers' readOnly: true external_schema: type: object additionalProperties: true nullable: true readOnly: true options: type: object additionalProperties: true user_access_level: type: string nullable: true readOnly: true description: The effective access level the user has for this object NullEnum: enum: - null parameters: 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/. EnvironmentIdPath: in: path name: environment_id required: true schema: type: string description: Deprecated. Use /api/projects/{project_id}/ instead. 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