List an entity’s relationships
/entities/{entity_uuid}/relationships
Returns the relationships involving the specified entity, where the entity is either the
from or the to side of the link. The related entity can be in any program on your
account. Results are paginated.
Each relationship is returned once with both forward_label and inverse_label, so you can
present it from either entity's point of view. See the
Relationship schema for the full shape.
Example Request
GETRequest Schema
entity_uuid
The entity UUID
page
per_page
The number of relationships per page (defaults to 30, max 500)
sort
Field to sort by; prefix with `-` for descending order
Available Response Data
14 Data Pointsuuid uuid
The relationship's UUID
relationship_type enum
The type of relationship: spouse_of, director_of, shareholder_of, trustee_of, beneficiary_of, parent_of, …
forward_label string (Human-readable label when read from the from entity (e.g. "Director of"))
inverse_label string (Human-readable label when read from the to entity (e.g. "Has director"))
symmetric boolean
When true the relationship reads the same from both sides
from_entity_uuid uuid
UUID of the entity the relationship is recorded from
to_entity_uuid uuid
UUID of the entity the relationship points to
percentage_ownership number (Ownership percentage (0-100) for relationship types that support it (such as shareholder_of, partner_in and owner_of))
source string (How the relationship was recorded (e.g. manual, workflow, report, kyb_discovery, import))
effective_from string (Optional date from which the relationship is effective (YYYY-MM-DD))
effective_to string (Optional date the relationship is effective until (YYYY-MM-DD))
comment string
Optional free-text comment describing the relationship
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 relationship in the entity 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.
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 an entity’s relationships?
Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.