GET /v1/subscriptions

Use this endpoint to retrieve all subscriptions associated with your API key. Results are ordered by creation date, newest first. To keep response sizes predictable, list responses do not include address filters or the signing secret — use GET /v1/subscriptions/:id to fetch a specific subscription with its inlined addresses.

Request

GET /v1/subscriptions

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer oth_YOUR_API_KEY`

Query parameters

integer

default:"50"

Number of subscriptions to return per page. Accepted range: 1–200. Values above 200 are clamped to 200.

string

Opaque cursor returned in a previous response. Pass this value to retrieve the next page of results. Omit this parameter to start from the beginning of the list.

Example request

curl "https://api.offthehook.dev/v1/subscriptions?limit=20" \
  -H "Authorization: Bearer oth_YOUR_API_KEY"

Response

200 OK

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

List responses do not include destination.secret or inline address filters. To retrieve a subscription’s address filters, call GET /v1/subscriptions/:id.

Response fields

object[]

required

Array of subscription objects for the current page. Empty array when no subscriptions exist.

Show item properties

string

required

Unique subscription identifier, prefixed with sub_.

object

required

Delivery target. Includes type and url. The secret field is never present in list responses.

string[]

required

Event kinds this subscription is subscribed to.

object

required

Contains an empty addresses array. Address filters are not inlined in list responses — use GET /v1/subscriptions/:id to retrieve them.

string

required

"enabled" or "disabled".

string

required

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

string

required

ISO 8601 creation timestamp.

string

required

ISO 8601 timestamp of the most recent update.

string

Opaque cursor for the next page. Pass this as the nextPageToken query parameter in your next request. When this field is absent, you have reached the last page.

Pagination

Pass nextPageToken from each response as a query parameter to retrieve the following page. When the field is absent from the response, you have retrieved all subscriptions. Pagination tokens are versioned and opaque — do not parse or construct them manually.

# First page
curl "https://api.offthehook.dev/v1/subscriptions?limit=20" \
  -H "Authorization: Bearer oth_YOUR_API_KEY"

# Next page using the token from the previous response
curl "https://api.offthehook.dev/v1/subscriptions?limit=20&nextPageToken=v1:..." \
  -H "Authorization: Bearer oth_YOUR_API_KEY"

Errors

Code	Description
`invalid_pagination_token`	The `nextPageToken` value is malformed or was issued by an incompatible version of the API.
`unauthorized`	The `Authorization` header is missing or the API key is invalid.

Subscriptions

Address Filters

Events

Utilities

Request

Headers

Query parameters

Example request

Response

Response fields

Errors

​Request

​Headers

​Query parameters

​Example request

​Response

​Response fields

​Pagination

​Errors

Request

Headers

Query parameters

Example request

Response

Response fields

Pagination

Errors