WatchEye · Notes

List notes

Q: 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.

GET

/notes

LIVE

Returns notes for the calling account. Results are paginated.
Notes are always attached to an entity (and the entity's program). Notes created in the
context of an event additionally carry an event_uuid. Use the filters to narrow to a
specific entity, program, event, or to a specific author or author type.

Request a Demo Contact Sales

List notes

Example Request

GET

request.http

key Auth: BearerAuth

GET /notes
Authorization: Bearer <your-api-key>
Accept: application/json

Request Schema

page

Optional

integer · query

per_page

Optional

integer · query

The number of notes per page (defaults to 30, max 500)

filter[entity_uuid]

Optional

uuid · query

filter[event_uuid]

Optional

uuid · query

filter[program_uuid]

Optional

uuid · query

filter[created_by]

Optional

enum · query, user | api_key

Filter to notes authored by any portal user (`user`) or any API key (`api_key`) on this account.

filter[created_by_user_uuid]

Optional

uuid · query

Filter to notes authored by a specific portal user.

filter[created_by_api_key_uuid]

Optional

uuid · query

Filter to notes authored by a specific API key.

filter[created_at_from]

Optional

date · query, ISO 8601 date-time

filter[created_at_to]

Optional

date · query, ISO 8601 date-time

sort

Optional

enum · query, created_at | -created_at | updated_at | -updated_at

Field to sort by; prefix with `-` for descending order

archived

Optional

boolean · query

Filter by archive status. * `true` - only archived notes * `false` - only non-archived notes Note: The API will accept the string 'true' or the number 1 for true and the string 'false' or the number 0 for false as well as the boolean values.

Available Response Data

13 Data Points

inventory_2 What You Receive

fingerprint

uuid uuid

The note's UUID

fingerprint

note_number string (A short obfuscated public identifier for the note (e.g. "N-A1-B2C-3D4"))

data_object

note_text string (The free-text content of the note (max 5000 characters))

data_object

created_by object

Identifies who created the note

fact_check

is_immutable boolean

When true, the note is an immutable audit-trail entry and cannot be edited or

fingerprint

entity_uuid uuid

UUID of the entity this note is attached to

fingerprint

program_uuid uuid

UUID of the program the entity belongs to

fingerprint

event_uuid uuid

UUID of the event this note is attached to, if any

schedule

archived_at timestamp (ISO 8601 timestamp at which the note was archived in the portal (null if not archived))

schedule

created_at timestamp

schedule

updated_at timestamp

data_object

meta object

pagination: current_page, per_page, total, last_page

fingerprint

api_reference uuid

unique request identifier for log tracing and audit

lock Full API documentation provided after vetting from our compliance team. Request sample response arrow_forward

By The Numbers

API Data Scale & Coverage tag

Unmatched data depth to power your compliance and verification workflows.

50M+

Phone & Email Records

40M+

Adverse Court Records

2BN+

Australian Universe Records

18M+

Real Estate Records

7M+

Deceased Records

980M+

Social Media & Employment Records

science

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.

Practical Applications

Technical Use Cases tag

format_list_bulleted

Reconciliation against your own system

Page through every note 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.

sync

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.

dashboard

Operational dashboards

Drive an internal dashboard from live counts. meta.total gives the size of the filtered set without fetching every page.

Trust & Assurance

Compliance & Security tag

Enterprise-grade infrastructure audited against the standards your regulators require.

verified_user

ISO 27001 Certified

enhanced_encryption

AES-256 Encryption

public

Australian Data Sovereignty

Integration & Support

Common Questions tag

Everything you need to know about implementation details and compliance infrastructure.

Filter by topic

help

Compliance Team

Global Data Support

Need help planning your custom integration or understanding our compliance coverage? Our team is here to assist.

rocket_launch Implementation

How do I filter and page through the results?

add

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.

rocket_launch Implementation

What are the rate limits?

add

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.

Enquire now

Ready to integrate List notes?

Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.

Call 03 9948 4089 · sales@globaldata.net.au

Request a Demo Contact Sales