Get a subscription

GET

/api/v1/subscriptions/{subscription_id}

const url = 'https://api.inside.chat/api/v1/subscriptions/example';
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.inside.chat/api/v1/subscriptions/example \
  --header 'Authorization: Bearer <token>'

Required scopes: website_read, event_read
Data access: –
MCP tool: subscription_get

Read this installation subscription. Signing keys are never disclosed.

Authorizations

installation_token
oauth_client_credentials
website_read event_read

Parameters

Path Parameters

subscription_id

required

string

/^sub_[a-f0-9]{32}$/

Responses

200

Current installation-authorized thin metadata. Cursors contain independent per-website positions; no total order is promised.

application/json

object

subscription

required

object

subscription_id

required

string

/^sub_[a-f0-9]{32}$/

website_ids

required

Array<string>

>= 1 items <= 50 items unique items

event_types

required

Concrete event types; family wildcards are expanded.

Array<string>

Allowed values: conversation.changed conversation.removed conversation.snapshot conversation.gap conversation.heartbeat visitor.changed visitor.removed visitor.snapshot visitor.gap visitor.heartbeat operator.changed operator.removed operator.snapshot operator.gap operator.heartbeat queue.changed queue.removed queue.snapshot queue.gap queue.heartbeat website.changed website.removed website.snapshot website.gap website.heartbeat privacy.changed privacy.removed privacy.snapshot privacy.gap privacy.heartbeat capture.changed capture.removed capture.snapshot capture.gap capture.heartbeat

revision

required

Send as If-Match: “” to replace or delete.

integer

>= 1

status

required

Allowed value: active

payload_mode

required

Allowed value: thin

delivery

required

object

mode

required

Allowed value: pull

created_at

required

Unix seconds.

integer

updated_at

required

Unix seconds.

integer

Example

{
  "subscription": {
    "event_types": [
      "conversation.changed"
    ],
    "status": "active",
    "payload_mode": "thin",
    "delivery": {
      "mode": "pull"
    }
  }
}

400

Malformed, duplicate, unsupported input or invalid cursor signature.

401

Expired, revoked or changed credential authority.

404

Subscription or website not granted; restriction filters and human consent credentials are unavailable for this feed.

409

Changed subscription revision, concurrent mutation, inventory limit, or replay_expired requiring reconciliation.

429

Application request quota exceeded.

503

Event family held, corrupt subscription or unavailable journal/control observations.