staqlydocs
REST APIAPI referenceChannels

Get a channel

Get a channel (channels:read); credentials are never returned

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/channels/{id}

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string

Response Body

OK

application/json
  1. response

A connected account. Credentials are stored sealed and never returned.

id*string
provider*string

Provider id (see GET /v1/providers)

name*string
handle*string

The account's handle on the platform (@name, a channel id)

avatar_url*string
profile_url*string
status*ChannelStatus

connected (works), needs_reconnect (the platform refused the credentials), disabled (turned off; targets on it fail without trying)

Value in"connected""needs_reconnect""disabled"
settings*

Provider-level defaults for new targets, and links (one of the provider's limits.link_modes) to choose what the channel does with links

links*LinksMode

What this channel does with the links in a post's text: settings.links, else the provider's limits.links

Value in"keep""remove""defang"
group_id*string

The channel group it belongs to (every channel is in exactly one; the Default group unless moved)

last_error*string
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
activity?

Read from the channel's targets. Only GET /v1/channels and GET /v1/channels/{id} include it (not webhook payloads).

curl -X GET 'https://staqly.example.com/v1/channels/string'
{  "id": "string",  "provider": "string",  "name": "string",  "handle": "string",  "avatar_url": "string",  "profile_url": "string",  "status": "connected",  "settings": {},  "links": "keep",  "group_id": "string",  "last_error": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "activity": {    "last_published_at": "2019-08-24T14:15:22Z",    "last_post_id": "string",    "next_publish_at": "2019-08-24T14:15:22Z",    "published_30d": 0  }}