API ReferenceSources

Read

Get detailed information about a specific data source connector.

Path parameters

short_namestringRequired

Technical identifier of the source type (e.g., ‘github’, ‘stripe’, ‘slack’)

Headers

x-api-keystringRequired

Response

Successful Response
namestring

Human-readable name of the data source connector (e.g., ‘GitHub’, ‘Stripe’, ‘PostgreSQL’).

short_namestring
Technical identifier used internally to reference this source type. Must be unique across all sources.
class_namestring
Python class name of the source implementation that handles data extraction logic.
idstringformat: "uuid"
Unique system identifier for this source type. Generated automatically when the source is registered.
created_atstringformat: "date-time"

Timestamp when this source type was registered in the system (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when this source type was last updated (ISO 8601 format).

config_fieldsobject
Schema definition for configuration fields required to customize this source. Describes field types, validation rules, and user interface hints.
descriptionstring or null
Detailed description explaining what data this source can extract and its typical use cases.
auth_methodslist of strings or null

List of supported authentication methods (e.g., ‘direct’, ‘oauth_browser’).

oauth_typestring or null

OAuth token type for OAuth sources (e.g., ‘access_only’, ‘with_refresh’).

requires_byocboolean or nullDefaults to false
Whether this OAuth source requires users to bring their own client.
auth_config_classstring or null

Python class name that defines the authentication configuration fields required for this source (only for DIRECT auth).

config_classstring or null

Python class name that defines the source-specific configuration options and parameters.

output_entity_definition_idslist of strings or null
List of entity definition IDs that this source can produce. Defines the data schema and structure that this connector outputs.
labelslist of strings or null
Categorization tags to help users discover and filter sources by domain or use case.
supports_continuousboolean or nullDefaults to false

Whether this source supports cursor-based continuous syncing for incremental data extraction. Sources with this capability can track their sync position and resume from where they left off.

auth_fieldsobject or null
Schema definition for authentication fields required to connect to this source. Only present for sources using DIRECT authentication. OAuth sources handle authentication through browser flows.

Errors