---
title: "Get the form schemas of an integration"
method: GET
path: "/api/v1/integrations/schema/{id}"
tags: ["Integrations"]
---

# Get the form schemas of an integration

`GET /api/v1/integrations/schema/{id}`

## Request

- Base URL: `https://pcp.example.com`
- URL: `https://pcp.example.com/api/v1/integrations/schema/{id}`
- Auth: HTTP bearer

Answers one JSON Schema per protocol, derived from the integration's validator. With a resource, properties the inventory or a matching bundle provides are annotated with x-inventory-value or x-bundle-value.

## Path parameters

- `id` string, required

## Query parameters

- `type` 'store' | 'source' | 'destination' | 'secret_provider' | 'inventory', required
- `urn_id` string, uuid
- `environment` string
- `draft` boolean

## Response `200`

OK

- GetIntegrationSchemaResponse: GetIntegrationSchemaResponse schema
  - `id` string, uuid
  - `name` string
  - `protocols` object[]
    - `bundle_fields` object, nullable
    - `initial` object
    - `schema` object
    - `scheme` string
  - `version` string

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `401`: Missing, invalid or expired credentials
- `403`: The caller may not do this
- `500`: Internal Server Error _(panics)_
- `default`

---

[API](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1.md) - [All operations](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/revisions/2ac049494a01?raw)
