Returns a list of allowed document types that can be uploaded for a candidate
In order to access this endpoint ensure that you do a GET request with an Authorization header containing your access token.
Headers:
Authorization : {token}
Result codes
403 Forbidden
200 OK
400 Bad request
500 Internal server error
Result
One or more document type objects will be returned and will have the following fields:
Field Name | Type | Description |
---|---|---|
Id | int | Unique identifier for the document type |
Name | string | Name of the document type e.g. CV/Transcript/Other |
IsCustomType | boolean | A boolean indicator which specifies whether the document type was defined by the user |
IsBuiltInType | boolean | A boolean indicator which specifies whether the document type is one of the native types defined by the ATS system |
Enabled | boolean | Indicates whether the document type is enabled.For built in document types this will always be true |
Response format
[
{
"Id": 1,
"Name": "CV",
"IsCustomType": false,
"IsBuiltInType": true,
"Enabled": true
},
{
"Id": 2,
"Name": "Transcript",
"IsCustomType": false,
"IsBuiltInType": true,
"Enabled": true
},
{
"Id": 23
"Name": "Candidate consent form"
"IsCustomType": true
"IsBuiltInType": false
"Enabled": true
}
]