Subscription
A saved filter for the Endorsement Stream: which endorsements’ changes to send you.
- Returned by
GET /v1/subscriptions,POST /v1/subscriptions- Shapes
- The full record is in GET /v1/subscriptions. The shorter forms in the body of POST and PUT leave some fields out; a field that isn’t in every form says where it is.
Good to know
- In a filter, fields combine with AND and the values within one field with OR; a missing field matches everything.
Fields
| Field | Type | Meaning | Example |
|---|---|---|---|
id | integer | Subscription id.Only in GET /v1/subscriptions. | 7 |
name | string | Name, unique in your account. | CA labor |
filter | object | Which endorsements: fields combine with AND, values within a field with OR, and a missing field matches everything. Each field takes at most 500 values. | — |
filter.categories | array of stringoptional | Endorser category slugs (GET /v1/endorser-categories).editorial, labor, environment, business, party, club, community, officials, … meanings | ["labor"] |
filter.endorsers | array of stringoptional | Endorser slugs (GET /v1/endorsers). | — |
filter.endorser_states | array of stringoptional | Endorsers’ home states (USPS codes), or "national". | — |
filter.states | array of stringoptionalTwo capital letters (USPS code) | States the contests are voted in. | ["CA"] |
filter.elections | array of stringoptional | Election slugs (GET /v1/elections). | — |
filter.contest_kinds | array of stringoptional | Contest kinds: candidate, measure or retention.candidate, measure, retention meanings | — |
filter.levels | array of stringoptional | Levels of government of the contests’ districts.federal, state, county, city, school, special meanings | — |
filter.types | array of stringoptional | Stream only: kinds of change.created, updated, deleted meanings | — |
created_at | stringISO 8601 date and time with time zone | When the subscription was created.Only in GET /v1/subscriptions. | 2026-10-15T17:20:04.112Z |
updated_at | stringISO 8601 date and time with time zone | When it last changed.Only in GET /v1/subscriptions. | 2026-10-15T17:20:04.112Z |