---
title: "List platform schemas and integration possibilities"
method: GET
path: "/api/v1/platforms"
tags: ["Platforms"]
---

# List platform schemas and integration possibilities

`GET /api/v1/platforms`

## Request

- Base URL: `https://www.poster.ly`
- URL: `https://www.poster.ly/api/v1/platforms`
- Auth: HTTP bearer

## Query parameters

- `platform` string
- `include_planned` boolean

## Response `200`

Platforms fetched successfully

- union
  - PlatformsResponse
    - `platforms` PlatformSchema[], required
      - `id` string, required
      - `aliases` string[]
      - `label` string, required
      - `status` 'supported' | 'planned', required
      - `summary` string
      - `content_limit` integer, nullable
      - `media` object
      - `post_types` string[], required
      - `analytics_supported` boolean
      - `settings_schema` object, required
        - `fields` object[], required
        - `example` object, required
      - `helper_tools` object[], required
      - `native_features` string[]
  - PlatformResponse
    - `platform` PlatformSchema, required
      - `id` string, required
      - `aliases` string[]
      - `label` string, required
      - `status` 'supported' | 'planned', required
      - `summary` string
      - `content_limit` integer, nullable
      - `media` object
      - `post_types` string[], required
      - `analytics_supported` boolean
      - `settings_schema` object, required
        - `fields` object[], required
        - `example` object, required
      - `helper_tools` object[], required
      - `native_features` string[]

## Other responses

- `401`: Invalid or missing API key
- `404`: Resource not found
- `429`: Too many requests

---

[API](https://skmtc.dev/poster/apis/posterly-api.md) · [All operations](https://skmtc.dev/poster/apis/posterly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/poster/apis/posterly-api/revisions/60be02a61f95?raw)