List case entities — the entity graph's nodes


About this API

To get the ins and outs of this API, please refer to our documentation page here


Service limitations

To ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.


How to use this page?

  1. Pick a preferred language on the right.
  2. Enter your API key in the header field. Don't have one yet or don't know what that is? Please refer to the following page here.
  3. Enter the required parameters below or try something yourself!
  4. Click the Try It! button!
📘

You can also click one of the HTTP response codes at the bottom to see an example of that specific response!

Path Params
uuid
required

Case id (uuid). A non-uuid value yields 400 invalid_id with source.parameter id.

Query Params
string
enum

Restrict to one entity type — serves the split Persons / Organisations tables. Any other value yields 400 invalid_parameter with source.parameter.

Allowed:
boolean

Omitted: all entities are returned — stale rows carry officer verdicts and stay visible (dimmed) by default. false excludes provider-dropped entities for consumers that only want the current graph population. Compared against the computed staleness. Any non-boolean value yields 400 invalid_parameter.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json