Skip to content

List only sources available to the current actor.

GET
/api/workspace/data-sources
curl --request GET \
--url https://example.com/api/workspace/data-sources \
--header 'Authorization: Bearer <token>'
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data
Array<object>
nullable

Runtime catalog metadata for one data source.

object
Id

Opaque runtime catalog item identifier.

string
nullable
StableId

Stable data-source identifier supplied by the provider.

string
nullable
Key

Human-readable data-source key supplied by the provider.

string
nullable
DisplayName

Represents display text with an invariant default value and optional locale-specific translations.

object
Default

The invariant default text.

string
nullable
Translations

Optional locale-specific translations keyed by locale code.

object
key
additional properties
string
Description

Represents display text with an invariant default value and optional locale-specific translations.

object
Default

The invariant default text.

string
nullable
Translations

Optional locale-specific translations keyed by locale code.

object
key
additional properties
string
SourceKind

Identifies the authoring surface that provides a DataSource.

integer format: int32
Allowed values: 0 1 2 3
OwnerModuleKey

Owning module key, when the source belongs to a module.

string
nullable
SchemaFingerprint

Descriptor fingerprint used for published-definition compatibility.

string
nullable
Version

Provider descriptor version.

integer format: int32
Categories

Current workspace categories, ordered for source selection.

Array<object>
nullable

A workspace-owned source classification.

object
Id
string
nullable
Name
string
nullable
DisplayOrder
integer format: int32
RowVersion
string format: uuid
OutputShape

Defines the shape returned by a DataSource execution.

integer format: int32
Allowed values: 1 2 3 4 5 6 7
RendererKinds

Renderer kinds supported by this source’s validated schema.

Array<integer>
nullable
Allowed values: 1 2 3 4 5 6 7 8
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": [
{
"SourceKind": 0,
"OutputShape": 1,
"RendererKinds": [
1
]
}
],
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}