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

# Get Platform Requirements

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

## 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}/requirements`
- Auth: HTTP bearer

Get validation requirements for a specific platform.

Returns:
- required_fields: Fields that must be filled
- limits: Character/count limits for fields
- inherits_from_content: Fields that can use Content values as fallback
- notes: Platform-specific tips

Used by frontend for:
- Real-time validation as user types
- Showing required field indicators
- Character counters

## Path parameters

- `platform` string, required

## Query parameters

- `workspace_id` string, nullable: The workspace asking: decides gated fields (Facebook and Instagram first comment)

## Response `200`

Successful Response

- PlatformRequirementsResponse: Platform requirements for validation. Used by frontend to: - Mark required fields in the form - Validate in real-time as user types - Show character counters
  - `platform` string, required
  - `display_name` string, required
  - `required_fields` string[]: Fields that must be filled for this platform
  - `optional_fields` string[]: Fields that can be filled but are not required
  - `limits` object: Character/count limits for fields
  - `inherits_from_content` string[]: Fields that can inherit from Content (title, description, tags)
  - `notes` string[]: Platform-specific notes or tips
  - `media` object, nullable: Media the platform takes, from the capability registry: {media_types, video: limits|null, image: limits|null, image_post_kind}.

## 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)