---
title: "Entities Metadata"
method: GET
path: "/v1/projects/{projectId}/datasets/{name}/entities"
tags: ["Entity Management"]
---

# Entities Metadata

`GET /v1/projects/{projectId}/datasets/{name}/entities`

This endpoint returns a list of the Entities of a Dataset. Please note that this endpoint only returns metadata of the entities not the data. If you want to get the data of all entities then please refer to [OData Dataset Service](/central-api-odata-endpoints/#odata-dataset-service)
You can provide `?deleted=true` to get only deleted entities.

## Path parameters

- `projectId` number, required
- `name` string, required

## Query parameters

- `viewAs` number

## Response `200`

OK

- EntitySummary[] — Standard Response
  - `uuid` string — The `uuid` of the Entity that uniquely identifies the Entity.
  - `createdAt` string — ISO date format. The time that the server received the Entity.
  - `updatedAt` string — Timestamp of the last update in ISO date format. `null` when there is only one version of the Entity.
  - `deletedAt` string — Timestamp of the deletion in ISO date format. `null` if the Entity is not deleted.
  - `creatorId` number — The ID of the Actor (App User, User, or Public Link) that originally created the Entity.
  - `conflict` 'soft' | 'hard' — Type of the conflict. `hard`: baseVersion conflicts and multiple versions update the same property `soft`: baseVersion conflicts but data updates are independent
  - `currentVersion` EntityVersionFields
    - `label` string — Label of the Entity
    - `current` boolean — if the version is the latest one
    - `creatorId` number — The ID of the Actor (App User, User, or Public Link) that originally created the Entity.
    - `userAgent` string — The self-identified `userAgent` of the device that created the `Entity` version.
    - `conflictingProperties` string[] — list of properties updated offline simultaneously.
    - `version` number — The version number of the Entity. Each update increments this number.
    - `baseVersion` number — The version number of the version that was the "base version" of this version.
    - `branchId` string — The uuid of a branch linking multiple offline entity updates together.
    - `trunkVersion` number — The version number of the last known base server version of an entity, in the case of an offline branch of updates.
    - `branchBaseVersion` number — The base version of the entity according to the submission. In the case of an offline branch of updates, this may not match the version of the base submission on Central.

## Changes

- **2026-08-25** `a0c2113b47dd` — 1 info
  - added the new optional `query` request parameter `viewAs`
- **2025-12-20** `022694254f0d` — 1 info
  - api operation id `Entities Metadata` removed and replaced with `entitiesMetadata`
- **2025-10-27** `b11b54eea487` — 1 info
  - removed the non-success response with the status `403`
- **2025-10-10** `196d7d957d94` — 1 info
  - endpoint added
- **2025-03-13** `e8c2858fd4eb` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/getodk/apis/odk-central-api/changes/v1/projects/:projectId/datasets/:name/entities/get.md)

---

[API](https://skmtc.dev/getodk/apis/odk-central-api.md) · [All operations](https://skmtc.dev/getodk/apis/odk-central-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getodk/odk-central-api/revisions/dc3ccc706398/schema)