list_data_entities
Paginated list of the things a project keeps records of, each with its component, owner, personal-data flag, retention note, review status and field count, narrowed by status, component, personal data or search words.
Return the data entities of one project in the project's order: each thing the analyst wrote down as a record the system keeps, with its plural, its description as HTML, the component whose records these are, the member who answers for it, whether it holds personal data, how long it is kept, where it stands in its review and how many fields it carries. Read it before designing a table, a form or an API payload, to learn what the business keeps records of in its own words; then read one entity with get_data_entity for its fields.
Narrow with status (draft, in_review, approved or deprecated), component_id (one component's entities), pii (true for entities holding personal data only) and search (words in the name, the plural or the description). A guest token reads the approved entities only, whatever status asks for.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
project_id*stringUUID of the project whose data entities to list.
statusstringoptionalNarrow to one status.
draftin_reviewapproveddeprecatedcomponent_idstringoptionalNarrow to the entities of one component, by UUID.
piibooleanoptional`true` lists the entities that hold personal data only.
searchstringoptionalWords the name, the plural or the description must contain.
limitintegeroptionalEntities per page (1..100, default 25).
1max100pageintegeroptional1-indexed page number.
1What it returns
{ "data": [ { "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13", "component_id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f", "name": "Order", "plural": "Orders", "description": "<p>One purchase a branch places, from the basket to the delivery note.</p>", "owner_id": "9b2e4f1a-3c5d-4e6f-8a7b-1c2d3e4f5a6b", "pii": true, "retention_note": "Kept seven years for tax; personal fields masked after two.", "status": "approved", "position": 1, "fields_count": 2, "created_at": "2026-10-20T09:20:00+00:00", "updated_at": "2026-10-27T11:30:00+00:00" } ], "meta": { "page": 1, "limit": 25, "total": 1, "has_more": false }}How it fails
VALIDATION_FAILEDstatus is not one of the four statuses, component_id is not a UUID, or search is longer than 120 characters.
RESOURCE_NOT_FOUNDunknown project_id, or a project outside the token's scope or the person's visibility.
TOKEN_MISSING_ABILITYtoken lacks data-entity:view-any.
How is this guide?
Last updated on