List entity watches - Crustdata Docs

Authorizations

Authorization

string

header

required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version

enum<string>

default:2025-11-01

required

API version to use. 2025-11-01 is the only accepted value. Send it on every call: it is enforced today on POST /watch/{dataset}/search, where a missing or unrecognized value returns 400, and the other watch routes accept a request without it rather than relying on that.

Available options:

2025-11-01

Example:

"2025-11-01"

Path Parameters

dataset

enum<string>

required

The dataset the watch is built on. Entity watches support person and company; there is no job entity watch, and job returns 404 here. Use /watch/job/search for jobs.

Available options:

person,

company

Example:

"person"

Query Parameters

status

enum<string>

Return only watches in this state. Omit to return every state.

Available options:

active,

paused,

suspended,

expired,

cancelled

Example:

"active"

limit

integer

default:100

Watches per page. Values above the maximum are clamped rather than rejected, as is a non-numeric value, which falls back to the default.

Required range: 1 <= x <= 500

Example:

50

offset

integer

default:0

Number of watches to skip. Negative values are clamped to 0.

Required range: x >= 0

Example:

0

Response

Your entity watches for this dataset.

integer

Example:

46936

kind

enum<string>

Available options:

entity

Example:

"entity"

dataset

enum<string>

Available options:

person,

company

Example:

"person"

api_version

string

Example:

"2025-11-01"

config_version

string

Example:

"2025-11-01"

status

enum<string>

Available options:

active,

paused,

suspended,

expired,

cancelled

Example:

"active"

entities

object

The records to watch, as a map of identifier type to values. The accepted keys are exactly the ones the dataset's enrich endpoint accepts, and they are resolved to canonical ids when the watch runs. One watch holds up to 50,000 subjects across all keys.

People accept professional_network_profile_urls and business_emails. Companies accept domains, names, professional_network_profile_urls, and crustdata_company_ids. Company ids must be positive integers; every other identifier is a non-empty string.

Show child attributes

track

object

The saved track tree.

Option 1
Option 2

Show child attributes

fields

string[] | null

config

object

Schedule, per-run caps, and data freshness for an entity watch.

Show child attributes

notifications

object[]

One delivery channel. Every channel on a watch receives every notification.

Option 1
Option 2
Option 3
Option 4

Show child attributes

created_at

string<date-time>

Example:

"2026-07-16T03:16:38.351849Z"

last_run_at

string<date-time> | null

Example:

"2026-07-16T13:39:18.598964Z"

notifications_count

integer

Example:

12

credits_consumed

number

Example:

60

last_notified_at

string<date-time> | null

Example:

"2026-07-16T13:39:18.598964Z"