List Credential Providers

List catalogued OAuth and service-account connection methods and whether each is available to the caller in this workspace and deployment. Optionally search provider names with a case-insensitive substring match. OAuth authorization options contain the exact provider IDs accepted by the browser connection endpoint; service-account methods list the exact create-body fields and mark secret fields write-only. The bounded set is returned in one page; nextCursor is always null.

GET/api/v2/credentials/providers

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Query Parameters

workspaceId*string

Workspace used to evaluate credential-provider availability and integration policy.

Length1 <= length <= 128
search?string

Case-insensitive substring match against the credential provider name.

Length1 <= length <= 200

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/credentials/providers?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "type": "oauth",
      "serviceId": "salesforce",
      "name": "Salesforce",
      "description": "Connect to Salesforce CRM data and operations.",
      "providerFamily": "salesforce",
      "available": true,
      "supportsReconnect": true,
      "authorizationOptions": [
        {
          "providerId": "salesforce",
          "label": "Production"
        },
        {
          "providerId": "salesforce-sandbox",
          "label": "Sandbox"
        }
      ]
    },
    {
      "type": "service_account",
      "serviceId": "zoom-service-account",
      "providerId": "zoom-service-account",
      "name": "Zoom server-to-server app",
      "description": "Connect Zoom with a server-to-server app.",
      "providerFamily": "zoom",
      "available": true,
      "docsUrl": "https://docs.sim.ai/integrations/zoom-service-account",
      "requiresClientGeneratedCredentialId": false,
      "fields": [
        {
          "id": "clientId",
          "label": "Client ID",
          "placeholder": "Paste the client ID",
          "required": true,
          "secret": false,
          "multiline": false
        },
        {
          "id": "clientSecret",
          "label": "Client secret",
          "placeholder": "Paste the client secret",
          "required": true,
          "secret": true,
          "multiline": false
        },
        {
          "id": "orgId",
          "label": "Account ID",
          "placeholder": "Paste the account ID",
          "required": true,
          "secret": false,
          "multiline": false
        }
      ]
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}