Skip to main content
POST
/
api
/
Automation
/
Search
/
CandidateDocuments
/
Filters
Candidate Documents search by automation filters.
curl --request POST \
  --url https://api.example.com/api/Automation/Search/CandidateDocuments/Filters \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": "<string>",
  "nextRunOnly": true,
  "maxRecords": 123,
  "automationId": 123,
  "orderBy": {
    "isAscending": true,
    "columnName": "<string>"
  }
}
'
[
  {
    "id": 123,
    "documentId": 123,
    "candidateId": 123,
    "candidateName": "<string>",
    "documentName": "<string>",
    "documentTypeId": 123,
    "documentTypeName": "<string>",
    "createdById": 123,
    "createdByName": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "expiryDate": "2023-11-07T05:31:56Z"
  }
]

Body

application/json
filters
string | null
nextRunOnly
boolean
maxRecords
integer<int32>
automationId
integer<int32>
orderBy
object

Response

200 - application/json

OK

id
integer<int32>
documentId
integer<int32>
candidateId
integer<int32>
candidateName
string | null
documentName
string | null
documentTypeId
integer<int32>
documentTypeName
string | null
createdById
integer<int32>
createdByName
string | null
createdDate
string<date-time>
expiryDate
string<date-time> | null