A provider represents a third-party service that users can connect to through Pipes. Providers are configured in the WorkOS Dashboard and define the OAuth scopes and credentials used during the authorization flow.
When listed for a specific user, each provider includes a connected_account field showing the user’s connection status.
{ "object": "data_provider", "id": "data_integration_01EHZNVPK3SFK441A1RGBFSHRT", "name": "GitHub", "description": "Connect your GitHub account to access repositories.", "slug": "github", "integration_type": "github", "credentials_type": "oauth2", "scopes": ["repo", "user:email"], "created_at": "2024-01-15T10:30:00.000Z", "updated_at": "2024-01-15T10:30:00.000Z", "connected_account": null }
providerRetrieves a list of available providers and the user’s connection status for each. Returns all providers configured for your environment, along with the user’s connected account information where applicable.
curl --request GET \ --url "https://api.workos.com/user_management/users/user_01EHZNVPK3SFK441A1RGBFSHRT/data_providers" \ --header "Authorization: Bearer sk_example_123456789"
GET/user_management /users /:user_id /data_providersParameters Returns object