# SearchSubscriptionCreated

## Fields

Nested fields are written with dots; `[]` marks the items of an array.

| Field | Type | Always present | Description |
|---|---|---|---|
| `active` | boolean | yes | — |
| `created_at` | date-time (RFC 3339, UTC) | yes | — |
| `endpoint_id` | string | yes | Endpoint ID: cbe_ and 24 hex digits. |
| `id` | string | yes | Subscription ID: sub_ and 24 hex digits. |
| `include_corrections` | boolean | yes | — |
| `kind` | string | yes | Set from the query. filing and firehose send filing.new events. One of: `filing`, `firehose`, `search`. [More](#kind) |
| `min_interval_s` | integer \| null | yes | Seconds to gather events into one digest. Null sends each event on its own. |
| `name` | string | yes | — |
| `query` | object | yes | The saved query: q, syntax, match, and filters, in the form /v3/search/parse returns. Tickers are turned into CIKs when you save, so there is no tickers member. [More](#query) |
| `query.filters` | object | yes | — |
| `query.match` | string | yes | One of: `exact`, `stem`. |
| `query.q` | string | yes | — |
| `query.syntax` | string | yes | One of: `sb`, `edgar`. |
| `updated_at` | date-time (RFC 3339, UTC) | yes | — |
| `resolved` | object | yes | Each ticker in the query and the CIKs it stood for when saved. Returned by POST, and by PATCH when it changes the query. |
| `resolved.tickers` | object | no | — |

## Field notes

### `kind`

search: q is not empty, or doctypes, primary_only=true or entityName is given. filing: otherwise, when any filing filter is given (forms, form_types, form_families, and their exclusions, ciks, tickers, sics, states, inc_states, locationCode, items). firehose: none of these. A filing subscription counts against limits.filter. Text subscriptions (kind search) are not offered. A query with q, doctypes, primary_only=true, or entityName returns 400 invalid_parameter.

### `query`

items is kept as given. accepted_from and accepted_to are always null.

## Used by

- Returned by [`POST /v3/search/subscriptions`](https://www.secblast.com/docs/reference/post-search-subscriptions).
