Provider Specifications

Get provider specification

Retrieves a specific provider specification by ID.

get/provider-specifications/{provider_specification_id}

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Path parameters

provider_specification_idstring required

Unique identifier of the provider specification.

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Response

Successful response

object'provider.specification' required

String representing the object's type

idstring required

Unique specification identifier

keystring required

Unique specification key

namestring required

Display name

descriptionstring nullable required

Description

config_schemaobject required

JSON Schema defining the configuration structure

config_visibility'encrypted' | 'plain' required

Visibility level of the configuration

provider_idstring required

Provider ID

created_atstring date-time required

Timestamp when created

updated_atstring date-time required

Timestamp when last updated

Example response

{
  "id": "psp_9gHjKlMnPqRsTuVw",
  "key": "github",
  "name": "GitHub",
  "description": "GitHub API integration",
  "tools": [
    {
      "id": "pto_5jKlMnPqRsTuVwXy",
      "key": "create_issue",
      "name": "Create Issue",
      "description": "Creates a new issue in a GitHub repository",
      "specification_id": "psp_9gHjKlMnPqRsTuVw",
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z"
    }
  ],
  "tool_categories": [
    {
      "key": "crm",
      "name": "Zoho CRM",
      "description": "Manage leads, contacts, deals and other CRM records",
      "image_url": "https://provider-logos.metorial-cdn.com/zoho-crm.svg",
      "tool_count": 24
    }
  ],
  "auth_methods": [
    {
      "id": "pam_2mNpQrStUvWxYzAb",
      "key": "oauth2",
      "name": "OAuth 2.0",
      "description": "Authenticate using OAuth 2.0",
      "scopes": [
        {
          "id": "pams_8tUvWxYzAbCdEfGh",
          "scope": "repo",
          "name": "Repository Access",
          "description": "Full control of private repositories"
        }
      ],
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "provider_specification_id": "psp_9gHjKlMnPqRsTuVw",
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z"
    }
  ],
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.