Get a platform's posting schema

GET

/public/v1/platforms/{id}/schema

const url = 'https://api.loomta.com/public/v1/platforms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/schema';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.loomta.com/public/v1/platforms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/schema \
  --header 'Authorization: Bearer <token>'

Returns the content/media limits and the provider-specific setting fields for one platform. Read these account-specific values (e.g. the TikTok privacy_level options) before creating a post rather than hard-coding them.

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

The platform (connected account) UUID from GET /platforms.

Responses

200

The platform and its schema.

application/json

object

platform

required

object

string format: uuid

provider

Currently only tiktok is offered.

string

Allowed values: tiktok instagram threads

providerName

string

providerAccountId

string

displayName

string | null

displayHandle

string | null

displayImageUrl

string | null

disabled

boolean

refreshNeeded

boolean

tokenExpiresAt

string | null format: date-time

capabilities

Array<string>

metadata

object

key

additional properties

any

settings

object

key

additional properties

any

schema

required

object

provider

string

Allowed values: tiktok instagram threads

content

object

required

boolean

maxLength

integer | null

media

object

required

boolean

allowedTypes

Array<string>

Allowed values: image video audio file

minItems

integer

maxItems

integer

supportsMixedTypes

boolean

rules

Array<string>

comments

object

supported

boolean

mediaSupported

boolean

delayInMinutesSupported

boolean

settings

object

fields

Array<object>

object

name

string

type

string

Allowed values: string boolean enum

required

boolean

default

One of:

string
boolean

string

enum

Array<string>

description

string

Example

{
  "platform": {
    "provider": "tiktok",
    "providerName": "TikTok",
    "displayHandle": "@myhandle"
  },
  "schema": {
    "provider": "tiktok",
    "content": {
      "maxLength": 2200
    },
    "media": {
      "allowedTypes": [
        "image"
      ],
      "maxItems": 35
    },
    "settings": {
      "fields": [
        {
          "name": "privacy_level",
          "type": "string"
        }
      ]
    }
  }
}

401

The API key is missing or invalid.

application/json

object

code

required

A stable, machine-readable error code to branch on.

string

message

required

A human-readable description.

string

details

Optional structured detail (for example Zod validation issues).

Examples

{
  "code": "missing_api_key",
  "message": "A Bearer API key is required."
}

{
  "code": "invalid_api_key",
  "message": "The API key is invalid."
}

404

Platform is missing, disabled, or requires refresh.

application/json

object

code

required

A stable, machine-readable error code to branch on.

string

message

required

A human-readable description.

string

details

Optional structured detail (for example Zod validation issues).

Example

{
  "code": "platform_not_found",
  "message": "Platform is missing, disabled, or requires refresh."
}