Skip to content
Shout Help Center

Overview

Shout Public API v1

Section titled “Shout Public API v1”

Tenant-scoped REST API authenticated with secret API keys (prefix sk_). Send the key as Authorization: Bearer sk_..., or as X-Api-Key: sk_.... Rate limited to 120 requests per minute per key. Every request operates strictly within the tenant that owns the key. A Model Context Protocol (MCP) server backed by the same keys is exposed separately at /mcp.

Information

  • OpenAPI version: 3.0.4

Operations

Section titled “ Operations ”
GET
/v1/contacts
POST
/v1/contacts
GET
/v1/contacts/{id}
PUT
/v1/contacts/{id}
DELETE
/v1/contacts/{id}
POST
/v1/contacts/{id}/unsubscribe
POST
/v1/contacts/{id}/subscribe
GET
/v1/forms
POST
/v1/forms
GET
/v1/forms/{formId}
GET
/v1/groups
GET
/v1/inboxes
GET
/v1/livechat/sources
GET
/v1/livechat/sources/{sourceId}/articles
PUT
/v1/livechat/sources/{sourceId}/articles/{slug}
DELETE
/v1/livechat/sources/{sourceId}/articles/{slug}
GET
/v1/me
GET
/v1/organisations
GET
/v1/organisations/{id}
GET
/v1/forms/{formId}/responses
GET
/v1/forms/{formId}/responses/{responseId}
GET
/v1/tickets
GET
/v1/tickets/{id}
POST
/v1/tickets/{id}/replies
PUT
/v1/tickets/{id}/status
GET
/v1/webhooks
POST
/v1/webhooks
PUT
/v1/webhooks/{webhookId}
DELETE
/v1/webhooks/{webhookId}
POST
/v1/webhooks/{webhookId}/test
GET
/v1/workspaces

Authentication

Section titled “ Authentication ”

ApiKey

Section titled “ApiKey ”

Tenant-scoped secret API key (prefix sk_). Send it as Authorization: Bearer sk_.... The header X-Api-Key: sk_... is also accepted. Keys are minted in the Shout developer area and carry scopes that gate individual endpoints.

Security scheme type: http

Bearer format: sk_...