staqlydocs
REST APIAPI referenceChannels

The platform catalog

The platform catalog (channels:read)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/providers

Every platform staqly knows, with status available (can be connected) or soon, how it authenticates (oauth2, token or none), its posting limits, the fields a connection needs (token platforms) and the per-target settings its posts take. app_configured says whether an OAuth platform has a developer app (the workspace's own or the server's PROVIDER__CLIENT_ID / _CLIENT_SECRET).

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Response Body

OK

application/json
  1. response
data*array<>
curl -X GET 'https://staqly.example.com/v1/providers'
{  "data": [    {      "id": "custom",      "name": "string",      "auth": "oauth2",      "status": "available",      "limits": {        "max_chars": 0,        "max_media": 0,        "media_kinds": [          "image"        ],        "needs_title": true,        "needs_media": true,        "needs_link": true,        "links": "keep",        "link_modes": [          "keep"        ],        "image": {          "max_bytes": 0,          "formats": [            "string"          ],          "min_ratio": 0,          "max_ratio": 0,          "min_width": 0,          "max_pixels": 0,          "note": "string"        }      },      "credential_fields": [        {          "key": "string",          "label": "string",          "help": "string",          "kind": "text",          "max_length": 0,          "max_items": 0,          "options": [            {              "value": "string",              "label": "string"            }          ],          "required": true,          "default": "string",          "placeholder": "string",          "when": {            "key": "string",            "value": "string"          }        }      ],      "settings_fields": [        {          "key": "string",          "label": "string",          "help": "string",          "kind": "text",          "max_length": 0,          "max_items": 0,          "options": [            {              "value": "string",              "label": "string"            }          ],          "required": true,          "default": "string",          "placeholder": "string",          "when": {            "key": "string",            "value": "string"          }        }      ],      "app_configured": true,      "docs_url": "http://example.com"    }  ]}