Manage connections to data sources for authentication and data access.
Connections handle authentication with data sources and maintain the credentials needed for data extraction. Connections are typically created through the iframe UI, where users can:
- Provide username/password credentials
- Complete OAuth flows
- Configure additional connection parameters
Connection lifecycle:
- Create connection via iframe (provides OAuth or credential input)
- Validate connection status
- Use connection to create extracts
- Monitor connection health and refresh tokens as needed
List data source connections
Returns list of connections within workspace by data source
path Parameters
datasource_nameData source name
List data source connections › Responses
Get a list of Connections
countNumber of connections
nextURL to the next page
previousURL to the previous page
Delete a connection
Delete specified connection. Also related accounts are marked as inactive (is_active property becomes false) and related extractions are paused.
path Parameters
datasource_nameDatasource name
idConnection ID
Delete a connection › Responses
Delete a Connection
List external authentication links
Lists the external authentication links generated for this data source in the current
workspace, newest first. Each link carries its current status: not_used, used,
expired, or revoked_manually. An unknown datasource_name yields an empty list.
path Parameters
datasource_nameData source name
query Parameters
pagePage number
page_sizeNumber of items per page (max 1000)
List external authentication links › Responses
External authentication links
countNumber of external authentication links
nextURL to the next page
previousURL to the previous page
Generate external authentication links
Generates one-time links that let an external user (for example, the end client of an agency) authenticate a data source connection with their own credentials and select which accounts to grant — without having access to the workspace. This is the API equivalent of the platform UI action "Request credentials from another user".
One link is generated per email in to_emails; the email identifies the external user.
Links are single-use, expire after 14 days, and can be revoked.
Important: Requires the agency feature flag for external authentication links (contact Improvado to enable it). The endpoint returns
403when the flag is disabled.
path Parameters
datasource_nameData source name
Generate external authentication links › Request Body
to_emailsEmail addresses of the external users to generate links for. One link is generated per email; the email identifies the external user.
send_emailWhen true (default), Improvado also emails the generated link to each recipient.
Set to false to deliver the links yourself.
Generate external authentication links › Responses
External authentication links generated
Generated links, one per successfully processed email
failed_emailsEmails for which link creation failed
Revoke an external authentication link
Revokes a not-yet-used external authentication link so it can no longer be used to
authenticate. Idempotent — revoking an already-revoked link returns 200 with the
existing revocation data. Returns 400 if the link was already used or has expired.
path Parameters
datasource_nameData source name
idExternal authentication link ID
Revoke an external authentication link › Responses
Link revoked
idExternal authentication link ID
data_sourceData source name
data_source_titleHuman-readable data source title
statusCurrent status of the link
created_atWhen the link was generated
sent_to_emailEmail of the external user the link was generated for
senderEmail of the user who generated the link
revoked_atWhen the link was revoked, if it was
revoked_byEmail of the user who revoked the link; empty string if not revoked