Skip to main content
GET
cURL
💡 You could use this API to conditionally render something based on whether the recipient has subscribed to the target or not. state.enabled is resolved — it is what a send to this (target, medium) would actually do, computed by the same cascade the delivery path uses. The target does not need to be cataloged, or stored at all; any (channel, topic, event) resolves.
  • inherited: false means the recipient has explicitly overridden this (target, medium); true means the value came from elsewhere in the cascade.
  • cataloged: false means your project has no rule declared for that exact (target, medium) — context for rendering, not a predictor of delivery.
Remember the default is per medium: with nothing set anywhere, in_app resolves to enabled: true and email resolves to enabled: false.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer bv_xxxxxxxxx, where bv_xxxxxxxxx is your API Key with Full access or Recipient acess scope.

Path Parameters

recipient_id
string
required

The unique identifier of the recipient.

Query Parameters

channel
string
required

Channel to check.

topic
string
required

Topic to check.

event
string
required

Event to check.

medium
enum<string>
default:in_app

Which medium to check the subscription state for. Defaults to in_app.

Available options:
in_app,
email

Response

200 - application/json

Subscription state for the target