Get a merge review
Platform module
GET/merge-reviews/{id}mergeReviews.get
A fuzzy duplicate awaiting review. Fuzzy matches never merge automatically. Returns one merge review with its `ETag`. A merge review the caller may not see returns 404.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the merge review. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: MergeReview
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the merge review. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| similarity | number | Yes | Similarity score, 0.85 or higher. |
| decision | string | null | Yes | Reviewer decision. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| import_row_result_id | string (uuid) | Yes | Identifier of the import row that matched. |
| candidate_table | string | Yes | Table of the existing row.Constraints: pattern ^[a-z][a-z0-9_]*$ |
| candidate_id | string (uuid) | Yes | Identifier of the existing row it may duplicate. |
| decided_by | string (uuid) | null | Yes | Identifier of the person who decided, set from the session. |
| decided_at | string (date-time) | null | Yes | When they decided, set by the database. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"similarity": 0.91,
"decision": "Merge",
"import_row_result_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"candidate_table": "records",
"candidate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"decided_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/merge-reviews/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.mergeReviews.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.merge_reviews.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos merge-reviews get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f