List programs
/programs
Returns the programs belonging to the calling account.
Soft-deleted programs are excluded.
Results are paginated.
Example Request
GETRequest Schema
page
The page number to return
per_page
The number of programs per page (defaults to 30, max 500)
filter[status]
sort
Field to sort by; prefix with `-` for descending order
Available Response Data
13 Data Pointsuuid uuid
The program's UUID
program_number string (A short obfuscated public identifier for the program (e.g. "P-123-456-789"))
program_name string
The display name of the program
status enum
Lifecycle status of the program: active, paused, archived
report_emails array (Email addresses (max 5) that receive event report notifications for this program)
data_retention_months integer
How long, in months, to keep entity data for
event_grouping enum
Whether events from the same entity should be grouped into one event: separate, grouped
max_separate_events integer
When event_grouping is separate, the maximum number of separate events to create
default_risk_level enum
The risk level pre-filled when a new entity is added to this program: low, medium, high
created_at timestamp
ISO 8601 timestamp at which the program was created
updated_at timestamp
ISO 8601 timestamp at which the program was last updated
meta object
pagination: current_page, per_page, total, last_page
api_reference uuid
unique request identifier for log tracing and audit
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Sandbox Environment
Build and test against a sandbox account. Sandbox is a separate account with its own UUID and its own API keys, and the environment is fixed at the account level, so you cannot switch an existing key between live and sandbox with a parameter or header. Both share the same base URL, so the account behind your key is what determines which environment you are in. GET /v1/account returns an environment field of live or sandbox, and that is the authoritative answer.
Calls on a sandbox key are not billed. Every endpoint, response shape, error envelope, idempotency and rate-limit behaviour mirrors live, so the only change when you move to production should be the credentials. Sandbox accounts are provisioned by your Global Data account manager.
Technical Use Cases tag
Reconciliation against your own system
Page through every program on the account and compare it with your own records, so the two stay aligned without anyone exporting a spreadsheet. Filters use the filter[key]=value syntax and results are paginated.
Scheduled sync jobs
Sort by -created_at or -updated_at and pull only what has changed since the last run, which keeps a nightly sync proportional to the delta, not the whole book.
Operational dashboards
Drive an internal dashboard from live counts. meta.total gives the size of the filtered set without fetching every page.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
rocket_launch Implementation
How do I filter and page through the results?
add
How do I filter and page through the results?
Filters use the filter[key]=value syntax, and unknown keys are ignored, not rejected. Sorting uses the sort parameter, with a leading - for descending order.
One behaviour worth designing around: a filter targeting a UUID that is unknown, or that belongs to a different account, returns an empty page (data: [], meta.total: 0) instead of a 404. That is the same response as a filter which legitimately matches nothing, so an empty result does not on its own tell you the UUID was valid.
help_center General
Is this call billed?
add
Is this call billed?
Yes. This is a chargeable endpoint, and the fee is billed to your account at the time of the request. Your rates are set per account and confirmed by your Global Data account manager.
If your balance reaches zero or an agreed call limit is reached, further chargeable requests return 402 Payment Required until the account is topped up. Calls made with a key on a sandbox account are never charged.
rocket_launch Implementation
What are the rate limits?
add
What are the rate limits?
600 requests per minute by default, enforced with a 60-second fixed window. Every response carries X-RateLimit-Limit and X-RateLimit-Remaining.
Exceeding the limit returns 429 Too Many Requests with a Retry-After header giving the number of seconds to wait, and X-RateLimit-Reset giving the reset timestamp. Schedule retries from Retry-After instead of a fixed sleep, and slow down before you hit zero, not after.
Higher limits can be arranged case by case through WatchEye support.
Ready to integrate List programs?
Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.