---
title: "List revision candidates"
method: POST
path: "/hubs/{HubHashId}/projects/{ProjectId}/documents/revision_candidates"
tags: ["Document"]
---

# List revision candidates

`POST /hubs/{HubHashId}/projects/{ProjectId}/documents/revision_candidates`

## Request

- Base URL: `https://docs.bimtrackapp.co`
- URL: `https://docs.bimtrackapp.co/hubs/{HubHashId}/projects/{ProjectId}/documents/revision_candidates`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bimtrackapp/apis/newforma-konekt-document-control-api/docs/hubs/:HubHashId/projects/:ProjectId/documents/revision_candidates/post.ts> (a function with typed inputs; its response is checked against the schema)

Return potential parent documents for uploaded files based on filename matching and similarity. Returns up to 6 best matching documents or placeholders that the files could be revisions of.

## Path parameters

- `HubHashId` string, required
- `ProjectId` integer, required

## Request body

- FeaturesDocumentsRevisionCandidatesListRevisionCandidatesListRevisionCandidatesCommandListRevisionCandidatesCommandBody
  - `filesToMatch` FeaturesDocumentsRevisionCandidatesListRevisionCandidatesListRevisionCandidatesCommandFileToMatch[], nullable
    - `fileNameWithoutExtension` string, nullable
    - `extension` string, nullable

## Response `200`

OK

- FeaturesDocumentsRevisionCandidatesListRevisionCandidatesListRevisionCandidatesResponse
  - `revisionCandidatesByFileNames` object, nullable, required

## Other responses

- `307`: According to the hub id, the request is at the wrong datacenter. Please retry with the URL in the "Location" header.
- `400`: The request is malformed or has invalid parameters values.
- `402`: Insufficient subscription plan
- `403`: The request is not authenticated.
- `404`: The project doesn't exist.

---

[API](https://skmtc.dev/bimtrackapp/apis/newforma-konekt-document-control-api.md) - [All operations](https://skmtc.dev/bimtrackapp/apis/newforma-konekt-document-control-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bimtrackapp/apis/newforma-konekt-document-control-api/revisions/291f93a82556?raw)