---
title: "Get Provider"
method: GET
path: "/workspaces/{workspace_id}/providers/{provider_id}"
tags: ["providers"]
---

# Get Provider

`GET /workspaces/{workspace_id}/providers/{provider_id}`

## Request

- Base URL: `https://platform.tracecat.com/api`
- URL: `https://platform.tracecat.com/api/workspaces/{workspace_id}/providers/{provider_id}`
- Auth: one of:
  - API key in cookie `fastapiusersauth`
  - HTTP bearer

Get provider metadata, scopes, and schema.

## Path parameters

- `workspace_id` string, uuid, required
- `provider_id` string, required

## Query parameters

- `grant_type` 'authorization_code' | 'client_credentials': Grant type for OAuth 2.0.

## Response `200`

Successful Response

- ProviderRead
  - `grant_type` 'authorization_code' | 'client_credentials', required: Grant type for OAuth 2.0.
  - `metadata` ProviderMetadata, required: Metadata for a provider.
    - `id` string, required: Provider identifier
    - `name` string, required: Human-readable provider name
    - `description` string, required: Provider description
    - `logo_url` string, nullable: URL to provider logo
    - `setup_instructions` string, nullable: Setup instructions for the provider
    - `requires_config` boolean: Whether this provider requires additional configuration
    - `enabled` boolean: Whether this provider is available for use
    - `service_account_json` boolean: Whether the client secret is a service account JSON key instead of an OAuth client secret
    - `api_docs_url` string, nullable: URL to API documentation
    - `setup_guide_url` string, nullable: URL to setup guide
    - `troubleshooting_url` string, nullable: URL to troubleshooting documentation
  - `scopes` ProviderScopes, required: Scope metadata for a provider.
    - `default` string[], required: Default scopes for this provider.
  - `config_schema` ProviderSchema, required: Schema for a provider.
    - `json_schema` object, required
  - `integration_status` 'not_configured' | 'configured' | 'connected' | 'reauth_required', required: Status of an integration.
  - `default_authorization_endpoint` string, nullable
  - `default_token_endpoint` string, nullable
  - `authorization_endpoint_help` union
    - string
    - string[]
  - `token_endpoint_help` union
    - string
    - string[]
  - `redirect_uri` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/tracecat/apis/tracecat-api.md) - [All operations](https://skmtc.dev/tracecat/apis/tracecat-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tracecat/apis/tracecat-api/revisions/2efdda25045f?raw)