Service Providers

how to list all the available third party services a user could connect

Get all providers

get

Retrieves a list of all available providers.

Required scope: providers Access restriction: BlueNexus frontend OR whitelabel customer client only

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Responses

200

List of providers

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

/api/v1/providers

HTTPcURLJavaScriptPython

GET /api/v1/providers HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    []
  ]
}

Get a connection provider by ID

get

Retrieves a single connection provider by its ID.

Required scope: providers Access restriction: BlueNexus frontend OR whitelabel customer client only

Authorizations

access-token

AuthorizationstringRequired

Enter JWT access token

Path parameters

providerIdstringRequired

The ID of the provider

Example: google-workspace

Responses

200

Provider details

application/json

401

Unauthorized

application/json

404

Provider not found

application/json

500

Internal server error

application/json

get

/api/v1/providers/{providerId}

HTTPcURLJavaScriptPython

GET /api/v1/providers/{providerId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "label": "text",
  "color": "text",
  "enabled": true,
  "requiresAuthentication": true
}