Skip to main content
GET
Get a watcher

Authorizations

Authorization
string
header
required

Use an Orbit API key from the developer dashboard.

Path Parameters

watcher_id
string<uuid>
required

The watcher ID returned at creation.

Response

The watcher.

id
string<uuid>
required
orbit_id
string<uuid>
required

The watched profile.

enabled
boolean
required

Whether runs are scheduled.

interval_seconds
integer
required

Seconds between runs, from 3600 (hourly) to 2592000 (every 30 days).

created_at
string<date-time>
required
phases
enum<string>[] | null

Phases each run covers; null runs all three.

existing_sources watches sources already on the profile for updates; existing_socials watches the person's social activity; new_sources looks for new sources about the person.

Available options:
existing_sources,
existing_socials,
new_sources
next_run_at
string<date-time> | null

When the next run is scheduled.

last_run_at
string<date-time> | null
last_run_status
enum<string> | null

Outcome of the most recent run.

Available options:
dispatched,
completed,
failed,
null
run_count
integer
update_count
integer

Runs that found new information.

paused_reason
string | null

Set when Orbit paused the watcher, for example insufficient_credits.