---
title: "Search revision candidates"
method: GET
path: "/hubs/{HubHashId}/projects/{ProjectId}/documents/search_revision_candidates"
tags: ["Document"]
---

# Search revision candidates

`GET /hubs/{HubHashId}/projects/{ProjectId}/documents/search_revision_candidates`

## Request

- Base URL: `https://docs.bimtrackapp.co`
- URL: `https://docs.bimtrackapp.co/hubs/{HubHashId}/projects/{ProjectId}/documents/search_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/search_revision_candidates/get.ts> (a function with typed inputs; its response is checked against the schema)

Search for potential parent documents by file extension and search term.

## Path parameters

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

## Query parameters

- `extension` string
- `searchTerm` string

## Response `200`

OK

- FeaturesDocumentsRevisionCandidatesSearchRevisionCandidatesSearchRevisionCandidatesResponse
  - `revisionCandidates` FeaturesDocumentsRevisionCandidatesRevisionCandidateResponse[], nullable
    - `name` string, nullable, required
    - `number` string, nullable
    - `exactMatch` boolean
    - `documentId` string, nullable, required
    - `documentStatus` 1 | 2 | 3 | 4 | 5 | 6, required
    - `latestRevisionNumber` FeaturesDocumentsRevisionCandidatesRevisionCandidateResponseCandidateRevisionNumberResponse
      - `prefix` string, nullable
      - `number` string, nullable
      - `suffix` string, nullable
    - `metadataRevisionNumber` FeaturesDocumentsRevisionCandidatesRevisionCandidateResponseCandidateRevisionNumberResponse, required
      - `prefix` string, nullable
      - `number` string, nullable
      - `suffix` string, nullable
    - `revisionNumbersByPrefix` object, nullable

## 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)