Skip to main content
GET
/
workspaces
/
{workspace_id}
/
providers
/
{provider_id}
Error
A valid request URL is required to generate request examples
{
  "metadata": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "logo_url": "<string>",
    "setup_instructions": "<string>",
    "requires_config": false,
    "enabled": true,
    "api_docs_url": "<string>",
    "setup_guide_url": "<string>",
    "troubleshooting_url": "<string>"
  },
  "scopes": {
    "default": [
      "<string>"
    ]
  },
  "config_schema": {
    "json_schema": {}
  },
  "default_authorization_endpoint": "<string>",
  "default_token_endpoint": "<string>",
  "authorization_endpoint_help": "<string>",
  "token_endpoint_help": "<string>",
  "redirect_uri": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

workspace_id
string<uuid>
required
provider_id
string
required

Query Parameters

grant_type
enum<string>
default:authorization_code

Grant type for OAuth 2.0.

Available options:
authorization_code,
client_credentials

Response

Successful Response

grant_type
enum<string>
required

Grant type for OAuth 2.0.

Available options:
authorization_code,
client_credentials
metadata
ProviderMetadata · object
required

Metadata for a provider.

scopes
ProviderScopes · object
required

Scope metadata for a provider.

config_schema
ProviderSchema · object
required

Schema for a provider.

integration_status
enum<string>
required

Status of an integration.

Available options:
not_configured,
configured,
connected
default_authorization_endpoint
string | null
default_token_endpoint
string | null
authorization_endpoint_help
token_endpoint_help
redirect_uri
string | null