Skip to content

Get channel rules and settings schema

GET /public/v1/integration-settings/{id}

Describes what one channel accepts: how long a post can be, what its settings object must contain, the platform rules Sharek enforces, and which tools you can invoke on it.

Call this when you want to build a post correctly without hardcoding a provider’s schema, and to discover the methodName values for trigger a channel tool.

Also available as sharek integrations:settings (CLI) and integrationSchema (MCP), which takes a provider name rather than a channel id.

Parameter Required Description
id Yes The integration id from list channels.
Terminal window
curl -H "Authorization: your-api-key" \
https://dash.sharek.app/api/public/v1/integration-settings/channel-id
{
"output": {
"rules": "Text describing what this platform allows.",
"maxLength": 280,
"settings": { "...": "JSON schema for this provider's settings object" },
"tools": [
{
"methodName": "subreddits",
"description": "Get list of subreddits with information",
"dataSchema": [
{ "key": "word", "type": "string", "description": "Search subreddit by string" }
]
}
]
}
}
Field Description
rules Human-readable posting rules for the platform.
maxLength The character limit Sharek enforces for this channel. It can depend on the account: a verified account may get a higher limit than an unverified one on the same platform.
settings The validation schema for the provider’s settings object. When the provider takes no options, this is the string "No additional settings required" rather than an object, so check the type before parsing.
tools The tools this channel exposes, each with the methodName to call and the shape of its data. Empty for many providers.
  • maxLength is read per channel, not per provider, which is why this operation takes a channel id rather than a provider name.
  • A channel id that does not exist, or belongs to another organization, returns 404 {"msg": "Integration not found"}.
  • The static per-provider schemas are also written up one page per provider, each linked from the channels Sharek offers. Use those to read; use this operation when you want the live answer for a specific channel.