Skip to content

List Platforms API

The List Platforms API returns the social platforms available through the API together with the status of each platform. Use it before building a platform picker, checking coverage for a posting workflow, or debugging why an expected platform is not appearing in your integration. A single GET request returns a platforms array, and each entry carries a name and a status value that your code can use to decide how to present or route work for that platform.

When to check platform status before posting or scheduling

The List Platforms API is the discovery endpoint for platform coverage. Instead of hard-coding which social platforms your integration supports, call it at startup or before presenting platform options and render only what the response returns. That keeps your interface aligned with the platforms array actually returned, including platforms such as twitter when they appear in the response. Because the response is a list, treat it as data to parse and validate rather than as a fixed set: read each entry, check that both name and status are present, and handle the possibility that the list contains different platforms or statuses over time.

Request: GET with the x-access-key header

Send a GET request to the platforms path with the access key supplied in the x-access-key header. The header value is shown as a token placeholder in the request example titled List Platforms API request example, so replace that placeholder with your own token when you implement the call. There are no request parameters or request body fields in the captured contract for this endpoint. If the header is missing or invalid, do not assume a particular error shape, because no error response is documented for this endpoint in the source contract; handle transport and non-success responses generically in your client until an error contract is supplied.

Response body: the platforms array

A successful call returns HTTP 200 with an application/json body. The top-level object contains one required field, platforms, which is an array of platform objects. Each platform object contains two required string fields: name, which identifies the platform, and status, which describes the state of that platform as returned by the API. The field map titled List Platforms API response fields lists each field, its type, whether it is required, and its allowed values. Parse defensively: confirm the body is JSON, confirm platforms is an array, and skip or flag any entry that is missing name or status rather than crashing your platform picker.

Platform and status values

The name field uses a fixed set of platform identifiers: twitter, instagram, youtube, tiktok, pinterest, linkedin, bluesky, facebook, threads, and googlebusiness. The status field uses one of three values: prod, beta, or dev. In the worked example titled List Platforms API 200 response example, twitter is returned with a status of prod. Treat prod, beta, and dev as labels returned by the API for planning and display purposes. The captured contract does not define availability guarantees, feature differences, or promotion rules for those labels, so do not invent behavior such as automatically enabling, disabling, or restricting a platform based on status alone. If your product needs stricter handling for beta or dev platforms, that policy must come from a separate product decision, not from this endpoint contract.

Parsing the 200 response and checking for failures

To parse the response, first check for a 200 status, then decode the application/json body, then iterate over platforms. For each item, read name and status as strings and validate name against the known platform identifiers and status against prod, beta, and dev. Store the result as a list of name and status pairs for use in a dropdown, a settings screen, or a pre-flight check before a posting call. A common failure check is an empty or missing platforms array: if platforms is absent or not an array, treat the response as unexpected and surface a generic error instead of showing an empty platform list as if no platforms existed. Another check is an unknown name or status value: log it and handle it gracefully, because silently dropping it could hide a platform your users expect to see.

List Platforms API response fields
FieldTypeRequiredAllowed values / notes
platformsarray<object>YesTop-level array of platform objects in the 200 application/json response.
platforms[].namestringYestwitter | instagram | youtube | tiktok | pinterest | linkedin | bluesky | facebook | threads | googlebusiness
platforms[].statusstringYesprod | beta | dev

Exact captured contract; no additional fields are documented.

List Platforms API request example
curl -X GET "{{API_BASE_URL}}/v1/platforms" \
  -H "x-access-key: <token>"
List Platforms API 200 response example
{
  "platforms": [
    {
      "name": "twitter",
      "status": "prod"
    }
  ]
}
Interface fields
ScopeFieldTypeType referenceRequiredDescriptionConstraints
response#1responseobject__0
response#1response.platformsarray<object>__1Yes
response#1response.platforms[]object__2
response#1response.platforms[].namestring__3Yeskind: schemaValueIn; value: "twitter" | "instagram" | "youtube" | "tiktok" | "pinterest" | "linkedin" | "bluesky" | "facebook" | "threads" | "googlebusiness"
response#1response.platforms[].statusstring__4Yeskind: schemaValueIn; value: "prod" | "beta" | "dev"