Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.offthehook.dev/llms.txt

Use this file to discover all available pages before exploring further.

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

HeaderRequiredDescription
AuthorizationYesBearer oth_YOUR_API_KEY

​
Query parameters

​
limit
integer
default:"50"
Number of subscriptions to return per page. Accepted range: 1–200. Values above 200 are clamped to 200.
​
nextPageToken
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

​
items
object[]
required
Array of subscription objects for the current page. Empty array when no subscriptions exist.
​
nextPageToken
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

CodeDescription
invalid_pagination_tokenThe nextPageToken value is malformed or was issued by an incompatible version of the API.
unauthorizedThe Authorization header is missing or the API key is invalid.