Sign in

v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
Entity Management

Listing Versions

This returns the Entity metadata and data for every version of this Entity, in ascending creation order.

This endpoint supports retrieving extended metadata; provide a header X-Extended-Metadata: true to return a creator data object alongside the creatorId Actor ID reference.

There is an optional query flag relevantToConflict that returns the subset of past versions of an Entity that are relevant to the Entity's current conflict. This includes the latest version, the base version, the previous server version, and any other versions since the last time the Entity was in a conflict-free state. If the Entity is not in conflict, zero versions are returned.

get/v1/projects/{projectId}/datasets/{name}/entities/{uuid}/versions

Path parameters

projectIdnumber required

The numeric ID of the Project

namestring required

Name of the Dataset

uuidstring required

UUID of the Entity

Query parameters

relevantToConflictboolean

Flag to return only the versions of the entity that are relevant to the current conflict.

Response

OK

labelstring

Label of the Entity

currentboolean

if the version is the latest one

creatorIdnumber

The ID of the Actor (App User, User, or Public Link) that originally created the Entity.

userAgentstring

The self-identified userAgent of the device that created the Entity version.

conflictingPropertiesstring[]

list of properties updated offline simultaneously.

versionnumber

The version number of the Entity. Each update increments this number.

baseVersionnumber

The version number of the version that was the "base version" of this version.

branchIdstring

The uuid of a branch linking multiple offline entity updates together.

trunkVersionnumber

The version number of the last known base server version of an entity, in the case of an offline branch of updates.

branchBaseVersionnumber

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.

sourceobject

The source of the Entity version, such as a Submission or an API request. This property is experimental and may change in the future.

baseDiffstring[]

List of properties that are different between this version and its base version. Includes the label if it differs between the two versions.

serverDiffstring[]

List of properties that are different between this version and the previous version on the server. Includes the label if it differs between the two versions.

conflict'soft' | 'hard'

Type of the conflict if this version causes a conflict; otherwise null

resolvedboolean

Is the conflict resolved? Note that this is also false for the version which didn't cause a conflict

lastGoodVersionboolean

Indicates whether this version is the last known good version. Currently, the last known good version is defined as the version immediately prior to the first unresolved conflict. If there is no conflict, or if all conflicts are resolved, then the current version is the last known good version. This property is experimental, as the definition of the last known good version may change in the future.

relevantToConflictboolean

Indicates whether this version includes information relevant to resolving a conflict. If so, it will be shown to the user during conflict resolution. This property is experimental, as we may redefine conflict relevance in the future.

Example response

[
  {
    "label": "John (88)",
    "current": true,
    "creatorId": 1,
    "userAgent": "Enketo/3.0.4",
    "version": 2,
    "baseVersion": 1,
    "branchId": "b0e927b6-958a-42f6-8344-1deb37ee9672",
    "trunkVersion": 1,
    "branchBaseVersion": 1,
    "data": {
      "firstName": "John",
      "age": "88"
    },
    "dataReceived": {
      "firstName": "John",
      "age": "88",
      "label": "John (88)"
    },
    "source": {
      "event": {},
      "submission": {}
    },
    "baseDiff": [
      "name",
      "age"
    ],
    "serverDiff": [
      "name",
      "age"
    ]
  }
]