Dynamiq
Datasets

List dataset versions

Lists the versions of a dataset, highest version first. The dataset_id query parameter is required.

GET
/v1/dataset-versions

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Query Parameters

dataset_id*string

Dataset UUID to list versions for.

page?integer

Page number (1-based).

page_size?integer

Number of items per page. Values below the minimum or above the maximum are clamped to the nearest bound.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/dataset-versions?dataset_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
      "version": 0,
      "status": "draft",
      "schema": {
        "type": "any",
        "properties": {
          "property1": {
            "type": "any",
            "properties": {},
            "required": true
          },
          "property2": {
            "type": "any",
            "properties": {},
            "required": true
          }
        },
        "required": true
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "first_name": "string",
        "last_name": "string",
        "avatar_url": "string"
      },
      "updated_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "first_name": "string",
        "last_name": "string",
        "avatar_url": "string"
      }
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 0,
    "page_count": 0,
    "total_count": 0
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Create a dataset version

Creates a new draft version of a dataset. Drafts are mutable — you can add items, edit the schema, and release them. An optional `schema` constrains the fields of items added to the version; when omitted, the schema is inferred from the first items added. Draft versions carry a temporary, decreasing `version` number until they are released, at which point they take the next sequential positive version.

Get a dataset version

Returns a single dataset version, including its item `schema` and status.