Skip to main content
GET
List a watch's runs

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.

Available options:
person,
company,
job
Example:

"person"

watch_id
integer
required

The watch's id, returned when it was created.

Example:

46936

Query Parameters

limit
integer
default:20

Runs per page.

Required range: 1 <= x <= 1000
Example:

20

cursor
integer

The next_cursor from the previous page. Runs with an id below this are returned.

Example:

54811

only_credited
boolean
default:false

Return only runs that deducted credits.

Example:

false

Response

A page of runs, newest first.

A page of runs, newest first.

runs
object[]
next_cursor
integer | null

Pass this back as cursor for the next page. null on the last page.

Example:

54790

total_count
integer

All runs matching the query, not just this page.

Example:

42