Retrieve detailed information about a specific data source connector.
Returns the complete configuration for a source type, including:
- **Authentication fields**: Schema for credentials required to connect
- **Configuration fields**: Schema for optional settings and customization
- **Supported auth providers**: Pre-configured OAuth providers available for this source
Use this endpoint before creating a source connection to understand what
authentication and configuration values are required.
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.
config_fieldsobject
Schema definition for configuration fields required to customize this source.
descriptionstring or nullOptional
Detailed description explaining what data this source can extract and its typical use cases.
auth_methodslist of strings or nullOptional
List of supported authentication methods (e.g., ‘direct’, ‘oauth_browser’).
oauth_typestring or nullOptional
OAuth token type for OAuth sources (e.g., ‘access_only’, ‘with_refresh’).
requires_byocbooleanOptionalDefaults to false
Whether this OAuth source requires users to bring their own client.
auth_config_classstring or nullOptional
Python class name that defines the authentication configuration fields required for this source (only for DIRECT auth).
config_classstring or nullOptional
Python class name that defines the source-specific configuration options and parameters.
output_entity_definitionslist of stringsOptional
List of entity definition short names that this source can produce (e.g., [‘asana_task_entity’, ‘asana_project_entity’]).
labelslist of strings or nullOptional
Categorization tags to help users discover and filter sources by domain or use case.
supports_continuousbooleanOptionalDefaults to false
Whether this source supports cursor-based continuous syncing for incremental data extraction.
federated_searchbooleanOptionalDefaults to false
Whether this source uses federated search instead of traditional syncing.
supports_temporal_relevancebooleanOptionalDefaults to true
Whether this source’s entities have timestamps that enable recency-based ranking.
supports_access_controlbooleanOptionalDefaults to false
Whether this source supports document-level access control.
rate_limit_levelstring or nullOptional
Rate limiting level for this source: ‘org’ (organization-wide), ‘connection’ (per-connection/per-user), or None (no rate limiting).
feature_flagstring or nullOptional
Feature flag required to access this source. If set, only organizations with this feature enabled can see/use this source.
supports_browse_treebooleanOptionalDefaults to false
Whether this source supports lazy-loaded browse tree for selective node syncing.
auth_fieldsobject or nullOptional
Schema definition for authentication fields required to connect to this source.
supported_auth_providerslist of strings or nullOptional
List of auth provider short names that support this source.
