Retrieve a data source

Retrieves a data source object — information that describes the structure and columns of a data source — for a provided data source ID. The response adheres to any limits to an integration’s capabilities and the permissions of the parent database.

To fetch data source rows (i.e. the child pages of a data source) rather than columns, use the Query a data source endpoint.

Finding a data source ID

Navigate to the database URL in your Notion workspace. The ID is the string of characters in the URL that is between the slash following the workspace name (if applicable) and the question mark. The ID is a 32 characters alphanumeric string.

Notion database ID

Notion database ID

Then, use the Retrieve a database API to get a list of data_sources for that database. There is often only one data source, but when there are multiple, you may have the ID or name of the one you want to retrieve in mind (or you can retrieve each of them). Use that data source ID with this endpoint to get its properties.

To get a data source ID from the Notion app directly, the settings menu for a database includes a "Copy data source ID" button under "Manage data sources":

Screenshot of the "Manage data sources" menu for a database in Notion, with "Copy data source ID" button.

Screenshot of the "Manage data sources" menu for a database in Notion, with "Copy data source ID" button.

Refer to the Build your first integration guide for more details.

Errors

Each Public API endpoint can return several possible error codes. See the Error codes section of the Status codes documentation for more information.

Additional resources

📘

Data source relations must be shared with your integration

To retrieve data source properties from database relations, the related database must be shared with your integration in addition to the database being retrieved. If the related database is not shared, properties based on relations will not be included in the API response.

🚧

The Notion API does not support retrieving linked data sources

To fetch the information in a linked data source, share the original source database with your Notion integration.

Language