Skip to content

GET /v3/search/subscriptions

The organization's subscriptions, newest first, with limits by kind: filter (stored kind filing), firehose and search, each the plan's limit and the active subscriptions. 503 callbacks_unavailable while this server has no callback key file or its database lacks the callback tables.

API key: required. See Authentication.

Group: Webhooks (API: callbacks)

Parameters

NameInTypeRequiredDefaultDescription
limitqueryintegerno50Page size, 1..100 (GET).
cursorquerystringnoOpaque cursor from a previous page's next_cursor (GET).

Responses

StatusBodyDescription
200SearchSubscriptionList (application/json)OK
400Problem (application/problem+json)Invalid or unknown parameter, or a query error (invalid_query, query_too_complex, prefix_too_broad, negative_only_query, unsupported_operator, invalid_cursor); query errors carry position and length (characters of q).
401Problem (application/problem+json)Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728).
403Problem (application/problem+json)The credential's scope does not cover this route (code forbidden).
409Problem (application/problem+json)Conflict with the current state.
503Problem (application/problem+json)Full-text search cannot answer now: search_unavailable (sb_search unreachable or not configured), search_busy (its queue is full), search_timeout (the query hit its time budget), ticker_resolution_unavailable; or the database is unavailable. Retry after the Retry-After delay when one is given.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a SearchSubscriptionList object.

FieldTypeRequiredDescription
dataarray of SearchSubscriptionyes
has_morebooleanyes
limitsobjectyesBy kind: filter (stored kind filing), firehose, search. limit: the plan's (0 without); used: active subscriptions of that kind.
limits.filterobjectno
limits.filter.limitintegerno
limits.filter.usedintegerno
limits.firehoseobjectno
limits.firehose.limitintegerno
limits.firehose.usedintegerno
limits.searchobjectno
limits.search.limitintegerno
limits.search.usedintegerno
next_cursorstring | nullyes

Example request

Shell
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
  'https://api.secblast.com/v3/search/subscriptions'

Open this route in the console

More in Webhooks (API: callbacks)

Previous: POST /v3/callbacks/endpoints/{id}/verify · Next: POST /v3/search/subscriptions

Markdown version: /docs/reference/get-search-subscriptions.md