Skip to main content

Method

Retrieves a data source object using its ID.

Parameters

string
required
The ID of the data source to retrieve (with or without dashes)
string
Bearer token for authentication. Overrides the client-level auth if provided.

Response

Returns a DataSourceObjectResponse or PartialDataSourceObjectResponse.
string
Always "data_source"
string
The unique identifier of the data source
RichTextItemResponse[]
The title of the data source
RichTextItemResponse[]
The description of the data source
object
The parent of the data source. Can be a database or another data source.
string
Either "database_id" or "data_source_id"
string
The ID of the parent database (when type is database_id)
string
The ID of the parent data source (when type is data_source_id)
object
The parent of the data source’s containing database. This is typically a page, block, or workspace.
Record<string, DatabasePropertyConfigResponse>
The property schema of the data source
boolean
Whether the data source is inline
boolean
Whether the data source is archived
boolean
Whether the data source is in the trash
string
ISO 8601 timestamp when the data source was created
string
ISO 8601 timestamp when the data source was last edited
PartialUserObjectResponse
The user who created the data source
PartialUserObjectResponse
The user who last edited the data source
PageIconResponse | null
The icon of the data source
PageCoverResponse | null
The cover image of the data source
string
The Notion URL of the data source
string | null
The public URL of the data source if it is publicly accessible

Example

Error Handling