---
title: "List review records"
method: GET
path: "/reference-data/v1/reviews/{reviewDatasetUrn}/records"
tags: ["Reference data"]
---

# List review records

`GET /reference-data/v1/reviews/{reviewDatasetUrn}/records`

## Request

- Base URL: `https://your-environment.ataccama.one/api`
- URL: `https://your-environment.ataccama.one/api/reference-data/v1/reviews/{reviewDatasetUrn}/records`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/reference-data/v1/reviews/:reviewDatasetUrn/records/get.ts> (a function with typed inputs; its response is checked against the schema)

Inspect the records submitted for review.

The records are returned with their state information: a record under review has the state `REVIEW`.

## Path parameters

- `reviewDatasetUrn` string, uri, required: A URN identifying a review dataset resource in the Reference Data API. Format: urn:ata:{tenant}:reference-data:review:{uuid} Example: urn:ata:acme-corp:reference-data:review:423e4567-e89b-12d3-a456-426614174003.

## Query parameters

- `after` string
- `before` string
- `size` integer
- `attributeNames` string[]

## Response `200`

Paginated list of review records with state information.

- RecordsWithStateResponse: Paginated response for records with state information (draft and review records) following cursor-based pagination standard.
  - `meta` CursorPaginationMetadata, required: Pagination metadata for cursor-based pagination.
    - `prev` string: Cursor for previous page. Use with 'before' query parameter. Omitted on the first page.
    - `next` string: Cursor for next page. Use with 'after' query parameter. Omitted on the last page.
    - `total` integer: Optional total count of items.
  - `data` RecordWithState[], required: Array of record objects with state information.
    - `urn` string, uri, required: A URN identifying a record resource in the Reference Data API. Format: urn:ata:{tenant}:reference-data:record:{uuid} Example: urn:ata:acme-corp:reference-data:record:523e4567-e89b-12d3-a456-426614174004.
    - `values` RecordValue[], required: Record attribute values.
      - `name` string, required
      - `value` unknown
      - `recordUrn` string, uri: A URN identifying a record resource in the Reference Data API. Format: urn:ata:{tenant}:reference-data:record:{uuid} Example: urn:ata:acme-corp:reference-data:record:523e4567-e89b-12d3-a456-426614174004.
    - `lastChangedAt` string, date-time: When the values of the record were last changed. A change keeps the time it was made as it moves from draft through review to publishing, so on a published record this is the time of the change, not of the publish. Absent when no change is recorded for the record. Changes are recorded shortly after they are saved, so for a record changed moments ago this can still show the previous change, or be absent if there was none.
    - `lastChangedByUrn` string, uri: A URN identifying a user in the IAM API. Unlike most URNs, the last segment is the user ID as IAM knows it rather than a UUID. A user ID can be any string, for example, an email address, a UUID, or `service-account-{client ID}` for an API client. Characters that a URN cannot contain, such as spaces, `%`, or `#`, are percent-encoded as UTF-8 with uppercase hex digits; all other characters are kept as they are. Users cannot be listed or retrieved through the public API. To find a user's ID, open the user in the web application (**Global settings > User management > Users**). Format: urn:ata:{tenant}:iam:user:{user ID} Example: urn:ata:acme-corp:iam:user:jane.doe@acme-corp.com.
    - `state` string, required: @ExtensibleEnum The state of the record in reference data management: - `NEW`: Newly created record, not yet published. - `CHANGED`: Modified record with unpublished changes. - `DELETED`: Record marked for deletion; removed from the published dataset when the deletion is published. - `UNCHANGED`: Published record with no pending changes. - `REVIEW`: Record submitted for review. Once approved, the record returns to the draft and must still be published.

## Other responses

- `400`: Bad request. The request parameters or body are invalid.
- `403`: Forbidden. You do not have permission to access the requested resource.
- `404`: Not found. The requested resource does not exist.

---

[API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)