GET /v1/subscriptions/:id

Use this endpoint to fetch a single subscription by its ID. The response includes up to 200 address filters inlined in the filters.addresses array. If you have attached more than 200 addresses to the subscription, filters.hasMore will be true and you should paginate the full list using the dedicated addresses endpoint.

Request

GET /v1/subscriptions/:id

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer oth_YOUR_API_KEY`

Path parameters

string

required

The subscription ID to retrieve. Always starts with sub_.

Example request

curl https://api.offthehook.dev/v1/subscriptions/sub_2QkP9aB7xN... \
  -H "Authorization: Bearer oth_YOUR_API_KEY"

Response

200 OK

{
  "id": "sub_2QkP9aB7xN...",
  "destination": { "type": "https", "url": "https://your-server.example.com/webhooks" },
  "events": ["wallet.transfer.broadcasted"],
  "filters": {
    "addresses": [
      { "chainId": "tron:mainnet", "address": "TLsV52sRDL79HXGGm9yzwKibb6BeruhUzy" }
    ],
    "hasMore": false
  },
  "status": "enabled",
  "description": "Production wallet monitor",
  "dateCreated": "2026-05-08T12:00:00Z",
  "dateUpdated": "2026-05-08T12:00:00Z"
}

When filters.hasMore is true, there are more than 200 addresses attached to this subscription. Use GET /v1/subscriptions/:id/filters/addresses to paginate the full list.

Response fields

string

required

Unique subscription identifier, prefixed with sub_.

object

required

Webhook delivery target.

Show destination properties

string

required

Destination type. Currently always "https".

string

required

The HTTPS URL registered for this subscription.

destination.secret is never returned by this endpoint. To retrieve a new secret, use POST /v1/subscriptions/:id/secrets/rotate.

string[]

required

Event kinds this subscription is subscribed to.

object

required

Address filters attached to this subscription.

Show filters properties

object[]

required

Up to 200 inlined address filters. Each entry contains:

chainId — CAIP-2 chain identifier (e.g. "tron:mainnet", "tron:nile")
address — canonical base58check TRON address (e.g. "TLsV52sRDL79HXGGm9yzwKibb6BeruhUzy")

boolean

true when the subscription has more than 200 address filters. Use GET /v1/subscriptions/:id/filters/addresses to page through the full list.

string

required

"enabled" or "disabled".

string

required

Human-readable label. Empty string if none was set.

string

required

ISO 8601 timestamp of when the subscription was created.

string

required

ISO 8601 timestamp of the most recent update.

Errors

Code	Description
`not_found`	No subscription with the given ID exists under your API key.
`unauthorized`	The `Authorization` header is missing or the API key is invalid.

Subscriptions

Address Filters

Events

Utilities

GET /v1/subscriptions/:id

Request

Headers

Path parameters

Example request

Response

Response fields

Errors

​Request

​Headers

​Path parameters

​Example request

​Response

​Response fields

​Errors

Request

Headers

Path parameters

Example request

Response

Response fields

Errors