Deepnote Public API v2
Integrations API
Data source integrations and their usages.
Base URL
https://api.deepnote.com/v2List integrations
/integrationsParameters
integrationIdsquerystringComma-separated list of integration UUIDs to filter by (e.g. `?integrationIds=<uuid1>,<uuid2>`).
nameContainsquerystringFilter integrations whose name contains this value (case-insensitive).
typesquerystringComma-separated list of integration types to filter by exact match (e.g. `?types=big-query,snowflake`).
hasSchemaquery"true" | "false"Filter by whether the integration type supports schema discovery. Use `true` or `false`.
includeMetadataquery"true" | "false"Include decrypted integration connection metadata. Restricted to Admins with EDIT_INTEGRATIONS permission. Defaults to `false`.
Responses
▸200List of integrations
ListIntegrationsResponseintegrationsrequiredIntegrationListItem[]▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions to access integrations or integration metadata
ErrorResponsemessagerequiredstringGet integration with tables
/integrations/{integrationId}Parameters
integrationIdpathrequiredstring:uuiddatabaseNamequerystringFilter tables by database (relevant for Snowflake/BigQuery).
schemaNamequerystringFilter tables by schema.
tableNamequerystringFilter tables by exact table name.
includeMetadataquery"true" | "false"Include decrypted integration connection metadata. Restricted to Admins with EDIT_INTEGRATIONS permission. Defaults to `false`.
Responses
▸200Integration with tables
objectintegrationrequiredIntegrationListItemtablesrequiredTable[]▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Integration not found
ErrorResponsemessagerequiredstringGet integration block usages
/integrations/{integrationId}/usages/blockParameters
integrationIdpathrequiredstring:uuidprojectIdquerystring:uuidNarrow results to usages in a single project.
Responses
▸200Block usages
objecttyperequiredstringusagesrequiredBlockUsage[]▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Integration or project not found
ErrorResponsemessagerequiredstringGet integration notebook usages
/integrations/{integrationId}/usages/notebookParameters
integrationIdpathrequiredstring:uuidprojectIdquerystring:uuidNarrow results to usages in a single project.
Responses
▸200Notebook usages
objecttyperequiredstringusagesrequiredNotebookUsage[]▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Integration or project not found
ErrorResponsemessagerequiredstringGet integration project usages
/integrations/{integrationId}/usages/projectParameters
integrationIdpathrequiredstring:uuidprojectIdquerystring:uuidNarrow results to usages in a single project.
Responses
▸200Project usages
objecttyperequiredstringusagesrequiredProjectUsage[]▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Integration or project not found
ErrorResponsemessagerequiredstring