---
title: "Get Platform Schema"
method: GET
path: "/v2/platform-configs/schemas/{platform}"
tags: ["v2 - PlatformConfig"]
---

# Get Platform Schema

`GET /v2/platform-configs/schemas/{platform}`

## Request

- Base URL: `https://api.jubjubapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.jubjubapp.com/v2/platform-configs/schemas/{platform}`
- Auth: HTTP bearer

Get the settings schema for a specific platform.

Returns JSON schema and field definitions for the platform,
which the frontend can use to dynamically generate the settings form.

## Path parameters

- `platform` string, required

## Query parameters

- `workspace_id` string, nullable: The workspace the form is for: decides gated fields (Facebook and Instagram first comment)

## Response `200`

Successful Response

- PlatformSettingsSchema: Schema for a platform's settings.
  - `platform` string, required
  - `display_name` string, required
  - `fields` PlatformSchemaField[], required
    - `name` string, required
    - `type` string, required
    - `required` boolean
    - `description` string, nullable
    - `default` unknown
    - `enum_values` string[], nullable
    - `enum_labels` object, nullable: Value-to-label mapping for selects (e.g. {'1': 'Film & Animation'})
    - `max_length` integer, nullable
    - `min_length` integer, nullable
    - `ui_type` string, nullable: How to render: text, textarea, boolean, select, tag_input, number, custom
    - `custom_component` string, nullable: Frontend component name when ui_type='custom' (e.g. cover_picker, page_selector)
    - `placeholder` string, nullable
    - `hint` string, nullable: Tooltip/helper text for the user
    - `max_count` integer, nullable: Max number of items for array fields
    - `items_type` string, nullable: Type of items in array fields (e.g. 'string', 'object')
    - `items_schema` object, nullable: Shape of each item for object arrays (e.g. {'username': 'string'})
    - `accept` string, nullable: Accepted file types for file upload fields (e.g. '.srt')
  - `json_schema` object, required
  - `capabilities` object, nullable: What the platform takes, from the capability registry: media_types (video, image), per-type limits, required/optional fields, caption field and limit, image_post_kind, counts_as_went_out.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/jubjubapp/apis/jubjub-api.md) - [All operations](https://skmtc.dev/jubjubapp/apis/jubjub-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jubjubapp/apis/jubjub-api/revisions/353157b296f2?raw)