CheckHub API v1.76.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Welcome to CheckHub API documentation
Every method is protected and requires you to have a valid API Token.
If you don't have it yet, we strongly advise you to start by creating a new one.
To do so :
- Log into CheckHub ADMIN using your User/Password credentials
- Go to Settings > API Tokens
- Create a new token (you can use a token name like
Development
orStaging
)
If you have any questions, please ask !
Please use the following link for bug report: https://form.asana.com/?k=OngbuzmFRVTp_ZMEMuUAbg&d=718323232107850
Base URLs:
Email: CheckHub Technical Team
Authentication
-
API Key (token)
- Parameter Name: Authorization, in: header. Access token created through the admin panel eg. "D2NS9gyuq0hkChHE9fYLb49v3..."
-
API Key (csrf)
- Parameter Name: X-CSRF-TOKEN, in: header. Candidate token link eg. "02yEXtzgnTPpuHwrL"
-
API Key (companyToken)
- Parameter Name: Authorization, in: header. Integration company token created through the admin panel eg. "D2NS9gyuq0hkChHE9fYLb49v3..."
Account
Create new account
Code samples
POST https://api.checkhub.io/accounts HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/accounts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/accounts',
params: {
}, headers: headers
p JSON.parse(result)
POST /accounts
Body parameter
{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Account name |
reference | body | string | false | Account reference (unique identifier for the account) |
welcomeText | body | accountWelcomeTextBase | false | This scheme is a collection of account welcome text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» nl | body | string(html) | false | Used for users whose language is "Dutch" |
» fr | body | string(html) | false | Used for users whose language is "French" |
» de | body | string(html) | false | Used for users whose language is "German" |
» it | body | string(html) | false | Used for users whose language is "Italian" |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | account |
Get account collection
Code samples
GET https://api.checkhub.io/accounts HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/accounts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/accounts',
params: {
}, headers: headers
p JSON.parse(result)
GET /accounts
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Account collection order |
filter[name] | query | string | false | Search by account name |
filter[reference] | query | string | false | Search by account reference |
includeShared | query | boolean | false | To include accounts from the companies of the same company group |
includeWelcomeText | query | boolean | false | To include account 'welcomeText' relation |
includeCandidates | query | boolean | false | To include account 'candidates' relation. deprecated |
includeCandidatesCount | query | boolean | false | To include account 'candidatesCount' field which will show count of all related candidates |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidates": [
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | accountFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Delete account by {{id}}
Code samples
DELETE https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/accounts/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /accounts/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get account by {{id}}.
Code samples
GET https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/accounts/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /accounts/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeShared | query | boolean | false | To include accounts from the companies of the same company group |
includeCandidates | query | boolean | false | To include account 'candidates' relation. deprecated |
includeWelcomeText | query | boolean | false | To include account 'welcomeText' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidates": [
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | accountFindByIdResponse |
Update account by {{id}}
Code samples
PATCH https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/accounts/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /accounts/{id}
Body parameter
{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | false | Account name |
reference | body | string | false | Account reference (unique identifier for the account) |
welcomeText | body | accountWelcomeTextBase | false | This scheme is a collection of account welcome text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» nl | body | string(html) | false | Used for users whose language is "Dutch" |
» fr | body | string(html) | false | Used for users whose language is "French" |
» de | body | string(html) | false | Used for users whose language is "German" |
» it | body | string(html) | false | Used for users whose language is "Italian" |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | account |
Admin User
Get admin user collection
Code samples
GET https://api.checkhub.io/adminUsers HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUsers', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUsers',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUsers
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
filter[name] | query | string | false | Search by admin user firstName, lastName, email |
filter[languages][] | query | string | false | Search by admin language (or) |
includeCompany | query | boolean | false | To include admin user 'company' relation |
Enumerated Values
Parameter | Value |
---|---|
filter[languages][] | en |
filter[languages][] | fr |
filter[languages][] | nl |
filter[languages][] | de |
filter[languages][] | it |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create new admin user
Code samples
POST https://api.checkhub.io/adminUsers HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"password": "6kgiWMzhKD0IPzRS"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"password": "6kgiWMzhKD0IPzRS"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUsers', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUsers',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUsers
Body parameter
{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"password": "6kgiWMzhKD0IPzRS"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
gender | body | adminUserGender | false | Admin User Gender |
firstName | body | string | true | Admin User First Name |
lastName | body | string | true | Admin User Last Name |
body | string | true | Admin User Email address | |
phone | body | string | false | Admin User Phone |
position | body | string | false | Admin User Position |
language | body | adminUserLanguage | false | Admin User language |
forceChangePassword | body | boolean | false | Enable password force change |
password | body | string | true | Admin User Password |
Enumerated Values
Parameter | Value |
---|---|
gender | |
gender | male |
gender | female |
language | en |
language | fr |
language | nl |
language | de |
language | it |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUser |
Get admin user by {{id}}
Code samples
GET https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUsers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUsers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUsers/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCompany | query | boolean | false | To include admin user 'company' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserFindByIdResponse |
Update admin user by id
Code samples
PATCH https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"newPassword": "6kgiWMzhKD0IPzRS"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"newPassword": "6kgiWMzhKD0IPzRS"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/adminUsers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/adminUsers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /adminUsers/{id}
Body parameter
{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"newPassword": "6kgiWMzhKD0IPzRS"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
gender | body | adminUserGender | false | Admin User Gender |
firstName | body | string | false | Admin User First Name |
lastName | body | string | false | Admin User Last Name |
body | string | false | Admin User Email address | |
phone | body | string | false | Admin User Phone |
position | body | string | false | Admin User Position |
language | body | adminUserLanguage | false | Admin User language |
forceChangePassword | body | boolean | false | Enable password force change |
newPassword | body | string | false | New password for the user |
Enumerated Values
Parameter | Value |
---|---|
gender | |
gender | male |
gender | female |
language | en |
language | fr |
language | nl |
language | de |
language | it |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUser |
Delete admin user by id
Code samples
DELETE https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/adminUsers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/adminUsers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /adminUsers/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get access token for admin user
Code samples
POST https://api.checkhub.io/adminUsers/login HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"email": "[email protected]",
"password": "eTmESlA3000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/login',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"email": "[email protected]",
"password": "eTmESlA3000"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/login',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUsers/login', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUsers/login',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUsers/login
Body parameter
{
"email": "[email protected]",
"password": "eTmESlA3000"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | string | false | Admin user email | |
password | body | string | false | Admin user password |
Example responses
200 Response
{
"id": "TDzlHHx590XulC7KygP4MIo6BQGg2QKMO3UvEvwEtNssGISZ43FrRUmt2XzbxkOY",
"ttl": 86400,
"created": "2019-09-12T15:36:09.264Z",
"userId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | accessToken |
Delete access token for current admin user
Code samples
POST https://api.checkhub.io/adminUsers/logout HTTP/1.1
Host: api.checkhub.io
const headers = {
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/logout',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/logout',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUsers/logout', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUsers/logout',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUsers/logout
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Request was successful | None |
Get current admin user info
Code samples
GET https://api.checkhub.io/adminUsers/me/info HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/me/info',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/me/info',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUsers/me/info', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUsers/me/info',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUsers/me/info
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"elevioUserHash": "828caxxxxxxx4cdde",
"elevioGroups": [],
"elevioTraits": [],
"rights": [
"candidateCreate",
"candidateView"
],
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGetInfoResponse |
Change admin user password
Code samples
PUT https://api.checkhub.io/adminUsers/me/change-password HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"password": "1xzoJz1mGIMplacy",
"newPassword": "MxUVl7a3iPyuWR4s",
"confirmPassword": "MxUVl7a3iPyuWR4s"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/me/change-password',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"password": "1xzoJz1mGIMplacy",
"newPassword": "MxUVl7a3iPyuWR4s",
"confirmPassword": "MxUVl7a3iPyuWR4s"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/me/change-password',
{
method: 'PUT',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.put('https://api.checkhub.io/adminUsers/me/change-password', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.put 'https://api.checkhub.io/adminUsers/me/change-password',
params: {
}, headers: headers
p JSON.parse(result)
PUT /adminUsers/me/change-password
Body parameter
{
"password": "1xzoJz1mGIMplacy",
"newPassword": "MxUVl7a3iPyuWR4s",
"confirmPassword": "MxUVl7a3iPyuWR4s"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
password | body | string | false | Current password |
newPassword | body | string | false | New password |
confirmPassword | body | string | false | Confirm new password |
Example responses
200 Response
{
"isPasswordChanged": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserChangePasswordResponse |
Check uniqueness of the email
Code samples
POST https://api.checkhub.io/adminUsers/checkEmail HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"email": "[email protected]",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/checkEmail',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"email": "[email protected]",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/checkEmail',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUsers/checkEmail', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUsers/checkEmail',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUsers/checkEmail
Body parameter
{
"email": "[email protected]",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | string | true | Email to check | |
ownId | body | UUID_V4 | false | Unique identifier for the entity |
Example responses
200 Response
{
"isUnique": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserCheckEmailResponse |
Admin User Group
Get admin user group collection
Code samples
GET https://api.checkhub.io/adminUserGroups HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUserGroups', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUserGroups',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUserGroups
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Admin user group collection order |
filter[name] | query | string | false | Search by admin user group name |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGroupFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create new admin user group
Code samples
POST https://api.checkhub.io/adminUserGroups HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUserGroups', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUserGroups',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUserGroups
Body parameter
{
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Admin user group name |
adminUsers | body | [UUID_V4] | false | Array of admin users ids related to this group |
adminUserRights | body | [UUID_V4] | true | Array of admin user rights related to this group |
accounts | body | [UUID_V4] | false | Array of accounts for which admin users have access and the specified rights apply. |
isAllAccounts | body | boolean | false | Admin users in this group will have the assigned rights for all company accounts. |
isMain | body | boolean | false | If it is enabled the group includes all accounts, all access rights and at least one admin user |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGroup |
Get admin user group by {{id}}
Code samples
GET https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUserGroups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUserGroups/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGroup |
Update admin user group by id
Code samples
PATCH https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/adminUserGroups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /adminUserGroups/{id}
Body parameter
{
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | false | Admin user group name |
adminUsers | body | [UUID_V4] | false | Array of admin users ids related to this group |
adminUserRights | body | [UUID_V4] | false | Array of admin user rights related to this group |
accounts | body | [UUID_V4] | false | Array of accounts for which admin users have access and the specified rights apply. |
isAllAccounts | body | boolean | false | Admin users in this group will have the assigned rights for all company accounts. |
isMain | body | boolean | false | If it is enabled the group includes all accounts, all access rights and at least one admin user |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"isMain": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGroup |
Delete admin user group by id
Code samples
DELETE https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/adminUserGroups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /adminUserGroups/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Admin User Right
Get admin user right collection
Code samples
GET https://api.checkhub.io/adminUserRights HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserRights',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserRights',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUserRights', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUserRights',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUserRights
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Admin user right collection order |
filter[name] | query | string | false | Search by admin user right name |
filter[label] | query | string | false | Search by admin user right label |
filter[searchText] | query | string | false | Search by admin user right label/name free text |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | label asc |
order | label desc |
filter[name] | accountManagement |
filter[name] | candidateCreate |
filter[name] | candidateDelete |
filter[name] | candidateEdit |
filter[name] | candidateImport |
filter[name] | candidateView |
filter[name] | companySettings |
filter[name] | customFieldManagement |
filter[name] | documentTypeManagement |
filter[name] | documentTypeValidationManagement |
filter[name] | mergeSetManagement |
filter[name] | notificationManagement |
filter[name] | policiesManagement |
filter[name] | presetManagement |
filter[name] | resourceManagement |
filter[name] | superAdmin |
filter[name] | tagManagement |
filter[name] | themeManagement |
filter[name] | userCreate |
filter[name] | userGroupManagement |
filter[name] | userResetPassword |
filter[name] | formManagement |
filter[name] | signatureManagement |
filter[name] | registrationPageManagement |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "notificationManagement",
"label": "Access to Notification Management"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserRightFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Get admin user right by {{id}}
Code samples
GET https://api.checkhub.io/adminUserRights/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserRights/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserRights/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUserRights/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUserRights/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUserRights/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "notificationManagement",
"label": "Access to Notification Management"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserRightFindByIdResponse |
Candidate
Create a new Candidate.
Code samples
POST https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"customFields": [
{
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "custom_value"
}
],
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"customFields": [
{
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "custom_value"
}
],
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidates',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidates
Body parameter
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"customFields": [
{
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "custom_value"
}
],
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
accountId | body | UUID_V4 | true | Unique identifier for the entity |
body | string | true | Candidate Email address | |
firstName | body | string | true | User First Name |
lastName | body | string | true | User Last Name |
reference | body | string | false | Candidate reference |
language | body | language | true | none |
welcomeText | body | string | false | Welcome text for the candidate. (only if type 'custom' is selected) |
welcomeTextType | body | string | false | Welcome text type |
assigneeId | body | UUID_V4 | false | Unique identifier for the entity |
additionalEmails | body | [string] | false | Candidate additional emails. Not more than 5 emails |
snoozed | body | boolean | false | Turns off future notifications (email and SMS) to this candidate |
mobilePhone | body | string | false | User mobile phone number in the international format |
notes | body | string | false | Candidate additional notes |
deadline | body | DateISO(date-time) | false | Datetime in ISO format |
customFields | body | [candidateCreateCustomField] | false | Custom fields that will be applied to the candidate during creation. |
» customFieldId | body | UUID_V4 | false | Unique identifier for the entity |
» value | body | string | false | Custom field value |
tagIds | body | [UUID_V4] | false | Tags that will be applied to the candidate during creation. |
Enumerated Values
Parameter | Value |
---|---|
language | en |
language | fr |
language | nl |
language | de |
language | it |
welcomeTextType | default |
welcomeTextType | custom |
welcomeTextType | none |
Example responses
200 Response
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidate |
Get candidates collection matched by query params.
Code samples
GET https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidates',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidates
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
filter[reference] | query | string | false | Filter by candidate 'reference' field |
filter[firstName] | query | string | false | Filter by candidate 'firstName' field |
filter[lastName] | query | string | false | Filter by candidate 'lastName' field |
filter[archived] | query | boolean | false | Filter by candidate 'archived' field |
filter[accountId] | query | UUID_V4 | false | Filter by candidate 'accountId' field |
filter[tagIds][] | query | UUID_V4 | false | Filter by candidate related tag ids |
filter[searchText] | query | string | false | Search result by following properties: ('email', 'firstName', 'lastName', 'notes', 'reference', 'candidateCustomField.value') |
filter[statuses][] | query | candidateStatus | false | Filter result by custom statuses (or) |
filter[comments] | query | candidateCommentsFilter | false | Filter result by comments |
filter[assigneeId] | query | UUID_V4 | false | Filter by candidate 'assigneeId' field |
filter[isAssigned] | query | boolean | false | Filter by 'isAssigned' candidate |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
limit | query | number | false | Maximum number of items in the response default: 10 |
order | query | string | false | Candidates order |
includeCompany | query | boolean | false | You can include candidate 'company' relation |
includeAccount | query | boolean | false | You can include candidate 'account' relation |
includeDocumentStatistic | query | boolean | false | You can include candidate 'documentStatistic' relation |
includeConversation | query | boolean | false | You can include candidate 'conversation' relation |
includeCustomFields | query | boolean | false | You can include candidate 'customFields' relation |
includeUser | query | boolean | false | You can include candidate 'user' relation |
includeTags | query | boolean | false | You can include candidate 'tags' relation |
includeCandidateDocumentTypes | query | boolean | false | You can include candidate 'candidateDocumentTypes' relation |
includeResources | query | boolean | false | You can include candidate 'resources' relation |
includeAssignee | query | boolean | false | You can include candidate 'assignee' relation |
Enumerated Values
Parameter | Value |
---|---|
filter[statuses][] | open |
filter[statuses][] | pending |
filter[statuses][] | completed |
filter[comments] | all |
filter[comments] | unread |
order | candidate.createdAt asc |
order | candidate.createdAt desc |
order | candidate.updatedAt asc |
order | candidate.updatedAt desc |
order | candidate.lastName asc |
order | candidate.lastName desc |
order | candidate.deadline asc |
order | candidate.deadline desc |
order | custom_field_order.value.{customFieldId} |
Example responses
200 Response
[
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"documentStatistic": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"docRequestedTotal": 7,
"docProvidedTotal": 6,
"docMandatoryRequestedTotal": 4,
"docMandatoryProvidedTotal": 4,
"docOptionalRequestedTotal": 3,
"docOptionalProvidedTotal": 2,
"resourceTotal": 5,
"resourceCompletedTotal": 2,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"conversation": null,
"customFields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"user": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false
},
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"candidateDocumentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Delete Candidates
Code samples
DELETE https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidates',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidates
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
filter | query | candidateDeleteFilter | false | Delete Candidates filter params |
Example responses
200 Response
{
"count": 3
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDeleteResponse |
Deleting a model instance by {{id}} from the data source.
Code samples
DELETE https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidates/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidates/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate is deleted | successfullyCompletedRequest |
Get candidate by {{id}} from the data source.
Code samples
GET https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidates/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidates/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCompany | query | boolean | false | You can include candidate 'company' relation |
includeAccount | query | boolean | false | You can include candidate 'account' relation |
includeDocumentStatistic | query | boolean | false | You can include candidate 'documentStatistic' relation |
includeConversation | query | boolean | false | You can include candidate 'conversation' relation |
includeCustomFields | query | boolean | false | You can include candidate 'customFields' relation |
includeUser | query | boolean | false | You can include candidate 'user' relation |
includeTags | query | boolean | false | You can include candidate 'tags' relation |
includeCandidateDocumentTypes | query | boolean | false | You can include candidate 'candidateDocumentTypes' relation |
includeResources | query | boolean | false | You can include candidate 'resources' relation |
includeAssignee | query | boolean | false | You can include candidate 'assignee' relation |
Example responses
200 Response
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"documentStatistic": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"docRequestedTotal": 7,
"docProvidedTotal": 6,
"docMandatoryRequestedTotal": 4,
"docMandatoryProvidedTotal": 4,
"docOptionalRequestedTotal": 3,
"docOptionalProvidedTotal": 2,
"resourceTotal": 5,
"resourceCompletedTotal": 2,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"conversation": null,
"customFields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"user": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false
},
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"candidateDocumentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFindByIdResponse |
Edit candidate by {{id}}
Code samples
PATCH https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "<p>Hi!</p>>",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes about candidate",
"deadline": "2019-09-12T15:36:09.264Z",
"archived": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "<p>Hi!</p>>",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes about candidate",
"deadline": "2019-09-12T15:36:09.264Z",
"archived": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidates/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidates/{id}
Body parameter
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "<p>Hi!</p>>",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes about candidate",
"deadline": "2019-09-12T15:36:09.264Z",
"archived": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
accountId | body | UUID_V4 | true | Unique identifier for the entity |
body | string | true | Candidate Email address | |
firstName | body | string | true | User First Name |
lastName | body | string | true | User Last Name |
reference | body | string | true | Candidate reference |
language | body | language | true | none |
welcomeText | body | string | false | Candidate welcome text |
welcomeTextType | body | string | false | Candidate welcome type |
assigneeId | body | UUID_V4 | false | Unique identifier for the entity |
additionalEmails | body | [string] | false | Candidate additional emails. Not more than 5 emails |
snoozed | body | boolean | false | Turns off future notifications (email and SMS) to this candidate |
mobilePhone | body | string | false | User mobile phone number in the international format |
notes | body | string | false | Candidate additional notes |
deadline | body | DateISO(date-time) | false | Datetime in ISO format |
archived | body | boolean | false | Archive or Unarchive candidate |
Enumerated Values
Parameter | Value |
---|---|
language | en |
language | fr |
language | nl |
language | de |
language | it |
welcomeTextType | default |
welcomeTextType | custom |
welcomeTextType | none |
Example responses
200 Response
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidate |
Export candidates
Code samples
GET https://api.checkhub.io/candidates/export HTTP/1.1
Host: api.checkhub.io
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
const headers = {
'Accept':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/export',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/export',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidates/export', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidates/export',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidates/export
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
filter[archived] | query | boolean | false | Filter by candidate 'archived' field |
filter[accountId] | query | UUID_V4 | false | Filter by candidate 'accountId' field |
filter[tagIds][] | query | UUID_V4 | false | Filter by candidate related tag ids |
filter[searchText] | query | string | false | Search result by following properties: ('email', 'firstName', 'lastName', 'notes', 'reference', 'candidateCustomField.value') |
filter[statuses][] | query | candidateStatus | false | Filter result by custom statuses (or) |
filter[comments] | query | candidateCommentsFilter | false | Filter result by comments |
filter[assigneeId] | query | UUID_V4 | false | Filter by candidate 'assigneeId' field |
filter[isAssigned] | query | boolean | false | Filter by 'isAssigned' candidate |
order | query | string | false | Candidates order |
Enumerated Values
Parameter | Value |
---|---|
filter[statuses][] | open |
filter[statuses][] | pending |
filter[statuses][] | completed |
filter[comments] | all |
filter[comments] | unread |
order | candidate.createdAt asc |
order | candidate.createdAt desc |
order | candidate.updatedAt asc |
order | candidate.updatedAt desc |
order | candidate.lastName asc |
order | candidate.lastName desc |
order | candidate.deadline asc |
order | candidate.deadline desc |
order | custom_field_order.value.{customFieldId} |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Export XLSX file with candidates | string |
Import candidates with some relations
Code samples
POST https://api.checkhub.io/candidates/bulk HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"mode": "immediately",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidates": [
{
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"reference": "j_good1991",
"language": "en",
"deadline": "2019-09-12T15:36:09.264Z",
"additionalEmails": [
"[email protected]"
],
"mobilePhone": "+3801234567890",
"preset": "preset_1, preset_2",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFields": [
{
"reference": "string",
"value": "string"
}
]
}
],
"documents": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"description": "string",
"filename": "file_of_the_company_candidate_{candidateFirstName}",
"comment": "string",
"commentType": "info",
"mandatory": true,
"folder": "string"
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"tags": {
"create": [
"string"
],
"apply": [
"string"
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/bulk',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"mode": "immediately",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidates": [
{
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"reference": "j_good1991",
"language": "en",
"deadline": "2019-09-12T15:36:09.264Z",
"additionalEmails": [
"[email protected]"
],
"mobilePhone": "+3801234567890",
"preset": "preset_1, preset_2",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFields": [
{
"reference": "string",
"value": "string"
}
]
}
],
"documents": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"description": "string",
"filename": "file_of_the_company_candidate_{candidateFirstName}",
"comment": "string",
"commentType": "info",
"mandatory": true,
"folder": "string"
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"tags": {
"create": [
"string"
],
"apply": [
"string"
]
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/bulk',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidates/bulk', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidates/bulk',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidates/bulk
Body parameter
{
"mode": "immediately",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidates": [
{
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"reference": "j_good1991",
"language": "en",
"deadline": "2019-09-12T15:36:09.264Z",
"additionalEmails": [
"[email protected]"
],
"mobilePhone": "+3801234567890",
"preset": "preset_1, preset_2",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFields": [
{
"reference": "string",
"value": "string"
}
]
}
],
"documents": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"description": "string",
"filename": "file_of_the_company_candidate_{candidateFirstName}",
"comment": "string",
"commentType": "info",
"mandatory": true,
"folder": "string"
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"tags": {
"create": [
"string"
],
"apply": [
"string"
]
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
mode | body | string | true | Import mode |
accountId | body | UUID_V4 | true | Unique identifier for the entity |
candidates | body | [candidateBulkCandidate] | true | Candidates data |
» firstName | body | string | true | User First Name |
» lastName | body | string | true | User Last Name |
» email | body | string | true | Candidate Email address |
» reference | body | string | false | Candidate reference |
» language | body | language | true | none |
» deadline | body | DateISO(date-time) | false | Datetime in ISO format |
» additionalEmails | body | [string] | false | Candidate additional emails. Not more than 5 emails |
» mobilePhone | body | string | false | User mobile phone number in the international format |
» preset | body | string | false | Presets references with ',' separator |
» tags | body | [UUID_V4] | false | Tags that will be applied to the candidate during creation. |
» presetId | body | UUID_V4 | false | Unique identifier for the entity |
» assigneeId | body | UUID_V4 | false | Unique identifier for the entity |
» customFields | body | [object] | false | Candidate custom fields |
»» reference | body | string | true | Custom field reference |
»» value | body | string | true | Custom field value |
documents | body | [candidateBulkDocument] | true | Candidate Documents data |
» documentTypeId | body | UUID_V4 | true | Unique identifier for the entity |
» name | body | string | false | Candidate Document Type name |
» description | body | string | false | Candidate Document Type description |
» filename | body | string | false | Candidate Document filename. It can include dynamic fields like {candidateFirstName} |
» comment | body | string | false | Candidate Document Type comment |
» commentType | body | candidateDocumentTypeCommentType | false | Candidate document type comment type |
» mandatory | body | boolean | true | It says that Candidate Document Type is mandatory or optional for the candidate |
» folder | body | string | false | Candidate Document Type files folder name |
forms | body | [candidateBulkForm] | false | Candidate Forms data |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
» isMandatory | body | boolean | false | It says that form is mandatory or optional for the candidate. |
» signatureId | body | UUID_V4 | false | Unique identifier for the entity |
» fileId | body | UUID_V4 | false | Unique identifier for the entity |
resources | body | [candidateBulkResource] | true | Candidate resources data |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [resourceAction] | true | Resource actions (at least one action required) |
tags | body | candidateBulkTags | false | none |
» create | body | [string] | true | New tag names |
» apply | body | [string] | true | Selected tag names |
Enumerated Values
Parameter | Value |
---|---|
mode | immediately |
mode | postponed |
» language | en |
» language | fr |
» language | nl |
» language | de |
» language | it |
» commentType | info |
» commentType | success |
» commentType | warning |
» commentType | danger |
» actions | read |
» actions | complete |
» actions | eSign |
» actions | download |
» actions | read |
» actions | complete |
» actions | download |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "b_candidate100"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateBulkResponse |
Reset candidate pending
Code samples
POST https://api.checkhub.io/candidates/{id}/reset-candidate-pending HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidates/{id}/reset-candidate-pending', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidates/{id}/reset-candidate-pending
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate reminder is reset | successfullyCompletedRequest |
Get candidate last activity
Code samples
GET https://api.checkhub.io/candidates/{id}/last-activity HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}/last-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}/last-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidates/{id}/last-activity', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidates/{id}/last-activity',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidates/{id}/last-activity
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"email": {
"createdAt": "2019-09-12T15:36:09.264Z",
"target": "[email protected]",
"triggerType": "manually",
"templateName": "string",
"scenarioName": "string",
"scenarioEventName": "string",
"deliveryStatus": "string"
},
"sms": {
"createdAt": "2019-09-12T15:36:09.264Z",
"target": "00380506339231",
"triggerType": "manually",
"templateName": "string",
"scenarioName": "string",
"scenarioEventName": "string"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateGetLastActivityResponse |
Candidate Token
Get candidate token collection
Code samples
GET https://api.checkhub.io/candidateTokens HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateTokens', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateTokens',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateTokens
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate Token collection order |
filter[validToken] | query | candidateTokenValid | false | Search by candidate token state |
filter[ids][] | query | UUID_V4 | false | Search by candidate token ids (or) |
filter[candidateId] | query | UUID_V4 | false | Search by candidate token candidateId |
includeCandidate | query | boolean | false | To include candidateToken 'candidate' relation |
Enumerated Values
Parameter | Value |
---|---|
order | createdAt asc |
order | createdAt desc |
order | validToken asc |
order | validToken desc |
order | candidateId asc |
order | candidateId desc |
order | tokenLink asc |
order | tokenLink desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true,
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateTokenFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create candidate token
Code samples
POST https://api.checkhub.io/candidateTokens HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateTokens', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateTokens',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateTokens
Body parameter
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
validToken | body | candidateTokenValid | false | Is valid candidate token |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateToken |
Get candidate token by {{id}}
Code samples
GET https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateTokens/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateTokens/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateTokens/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCandidate | query | boolean | false | To include candidateToken 'candidate' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true,
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateTokenFindByIdResponse |
Update candidate token by {{id}}
Code samples
PATCH https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"validToken": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"validToken": true
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateTokens/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateTokens/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateTokens/{id}
Body parameter
{
"validToken": true
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
validToken | body | candidateTokenValid | false | Is valid candidate token |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateToken |
Delete candidate token by {{id}}
Code samples
DELETE https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateTokens/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateTokens/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateTokens/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get candidate token by {{link}}
Code samples
GET https://api.checkhub.io/candidateTokens/link/:link HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/link/:link',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/link/:link',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateTokens/link/:link', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateTokens/link/:link',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateTokens/link/:link
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
link | path | string | true | Token link |
Example responses
200 Response
{
"token": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateTokenFindByLinkResponse |
Candidate Tag
Remove tags from the candidate.
Code samples
DELETE https://api.checkhub.io/candidateTags/{candidateId} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
method: 'DELETE',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateTags/{candidateId}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateTags/{candidateId}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateTags/{candidateId}
Body parameter
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | path | UUID_V4 | true | The candidate ID for whom the operation will be performed. |
body | body | candidateTagDelete | false | none |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Add tags to the candidate.
Code samples
POST https://api.checkhub.io/candidateTags/{candidateId} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateTags/{candidateId}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateTags/{candidateId}',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateTags/{candidateId}
Body parameter
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | path | UUID_V4 | true | The candidate ID for whom the operation will be performed. |
body | body | candidateTagCreate | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateTagArray |
Candidate Custom Field
Add new custom fields for candidate
Code samples
POST https://api.checkhub.io/candidateCustomFields HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateCustomFields', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateCustomFields',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateCustomFields
Body parameter
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
customFieldId | body | UUID_V4 | true | Unique identifier for the entity |
value | body | any | false | none |
» anonymous | body | string | false | String custom field value |
» anonymous | body | string | false | Date custom field value (based on Company locale date format) |
» anonymous | body | string | false | Email custom field value |
» anonymous | body | string | false | Simple List selected option |
» anonymous | body | [string] | false | Multiple List selected options |
» anonymous | body | object | false | Simple Query selected option |
»» label | body | string | true | Option Label |
»» value | body | string | true | Option Value |
»» id | body | string | false | Option unique field |
» anonymous | body | [object] | false | Multiple Query selected options |
»» label | body | string | true | Option Label |
»» value | body | string | true | Option Value |
»» id | body | string | false | Option unique field |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateCustomField |
Get list of candidate custom fields
Code samples
GET https://api.checkhub.io/candidateCustomFields HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateCustomFields', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateCustomFields',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateCustomFields
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate custom field collection order |
filter[candidateId] | query | UUID_V4 | false | Search by candidateId |
filter[customFieldId] | query | UUID_V4 | false | Search by customFieldId |
filter[value] | query | string | false | Search by value |
includeCustomField | query | boolean | false | To include candidate custom field 'customField' relation |
includeCandidate | query | boolean | false | To include candidate custom field 'candidate' relation |
Enumerated Values
Parameter | Value |
---|---|
order | candidateId asc |
order | candidateId desc |
order | value asc |
order | value desc |
order | customFieldId asc |
order | customFieldId desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateCustomFieldFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Deleting custom field by {{id}} from candidate
Code samples
DELETE https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateCustomFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateCustomFields/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get candidate custom field by {{id}}
Code samples
GET https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateCustomFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateCustomFields/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCustomField | query | boolean | false | To include candidate custom field 'customField' relation |
includeCandidate | query | boolean | false | To include candidate custom field 'candidate' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateCustomFieldFindByIdResponse |
Update candidate custom field by {{id}}
Code samples
PATCH https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"value": "1234-456-32"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"value": "1234-456-32"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateCustomFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateCustomFields/{id}
Body parameter
{
"value": "1234-456-32"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
value | body | string | true | The value of the candidate's custom field. |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateCustomField |
Candidate Document Type
Create a new Candidate Document Type.
Code samples
POST https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false,
"folder": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false,
"folder": "string"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateDocumentTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateDocumentTypes',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateDocumentTypes
Body parameter
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false,
"folder": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
documentTypeId | body | UUID_V4 | true | Unique identifier for the entity |
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
name | body | string | true | Candidate Document Type name |
description | body | string | false | Candidate Document Type description |
filename | body | string | true | Document type filename. It can include dynamic fields like {candidateFirstname} |
comment | body | string | false | Candidate Document Type comment |
commentType | body | candidateDocumentTypeCommentType | false | Candidate document type comment type |
mandatory | body | boolean | true | It says that Candidate Document Type is mandatory or optional for the candidate |
isPaused | body | boolean | false | Cancels the automatic confirm of the document if the uploading is not confirmed manually. |
folder | body | string | false | Candidate Document Type files folder name |
Enumerated Values
Parameter | Value |
---|---|
commentType | info |
commentType | success |
commentType | warning |
commentType | danger |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentType |
Get candidate document type collection
Code samples
GET https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateDocumentTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateDocumentTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateDocumentTypes
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate Document type collection order |
filter[accountId] | query | UUID_V4 | false | Filter result by candidate account id 'accountId' |
filter[candidateId] | query | UUID_V4 | false | Filter result by candidate id 'candidateId' |
filter[candidateEmail] | query | string | false | Filter result by candidate 'email' |
filter[candidateArchived] | query | boolean | false | Filter result by candidate 'archived' |
filter[searchText] | query | string | false | Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name') |
filter[customStatuses][] | query | candidateDocumentTypeStatus | false | Filter result by custom statuses (or) |
filter[createdAtFrom] | query | DateISO | false | Filter result by creation time >= |
filter[createdAtTo] | query | DateISO | false | Filter result by creation time <= |
filter[updatedAtFrom] | query | DateISO | false | Filter result by update time >= |
filter[updatedAtTo] | query | DateISO | false | Filter result by update time <= |
filter[assigneeId] | query | UUID_V4 | false | Filter result by candidate 'assigneeId' field |
filter[isAssigned] | query | boolean | false | Filter result by 'isAssigned' candidate |
includeCustomFields | query | boolean | false | To include 'customFields' relation |
includeDocumentType | query | boolean | false | To include 'documentType' relation |
includeCandidate | query | boolean | false | To include 'candidate' relation |
includeDocuments | query | boolean | false | To include 'documents' relation |
includeCandidateAssignee | query | boolean | false | To include candidate with 'assignee' relation |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[customStatuses][] | provided |
filter[customStatuses][] | pending |
filter[customStatuses][] | validated |
filter[customStatuses][] | expired |
filter[customStatuses][] | rejected |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false,
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "validated",
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
],
"customFields": [
{
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
},
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentTypeFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Update candidate document types
Code samples
PATCH https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customStatus": "validated"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customStatus": "validated"
}
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateDocumentTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateDocumentTypes',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateDocumentTypes
Body parameter
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customStatus": "validated"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | candidateDocumentTypeUpdateBody | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentTypeArray |
Change candidate document types
Code samples
PUT https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"create": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false,
"folder": "string"
}
],
"delete": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"create": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false,
"folder": "string"
}
],
"delete": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'PUT',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.put('https://api.checkhub.io/candidateDocumentTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.put 'https://api.checkhub.io/candidateDocumentTypes',
params: {
}, headers: headers
p JSON.parse(result)
PUT /candidateDocumentTypes
Body parameter
{
"create": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false,
"folder": "string"
}
],
"delete": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | candidateDocumentTypeChangeBody | false | none |
Example responses
200 Response
{
"created": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentTypeChangeResponse |
Delete candidate document types
Code samples
DELETE https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'DELETE',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateDocumentTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateDocumentTypes',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateDocumentTypes
Body parameter
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate Document type collection order |
filter[accountId] | query | UUID_V4 | false | Filter result by candidate account id 'accountId' |
filter[candidateId] | query | UUID_V4 | false | Filter result by candidate id 'candidateId' |
filter[candidateEmail] | query | string | false | Filter result by candidate 'email' |
filter[candidateArchived] | query | boolean | false | Filter result by candidate 'archived' |
filter[searchText] | query | string | false | Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name') |
filter[customStatuses][] | query | candidateDocumentTypeStatus | false | Filter result by custom statuses (or) |
ids | body | [UUID_V4] | true | Candidate document type ids |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[customStatuses][] | provided |
filter[customStatuses][] | pending |
filter[customStatuses][] | validated |
filter[customStatuses][] | expired |
filter[customStatuses][] | rejected |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get candidate document type by {{id}}
Code samples
GET https://api.checkhub.io/candidateDocumentTypes/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateDocumentTypes/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateDocumentTypes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateDocumentTypes/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCustomFields | query | boolean | false | To include 'customFields' relation |
includeDocumentType | query | boolean | false | To include 'documentType' relation |
includeCandidate | query | boolean | false | To include 'candidate' relation |
includeDocuments | query | boolean | false | To include 'documents' relation |
includeCandidateAssignee | query | boolean | false | To include candidate with 'assignee' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false,
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "validated",
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
],
"customFields": [
{
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
},
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentTypeFindByIdResponse |
Update candidate document type by {{id}}
Code samples
PATCH https://api.checkhub.io/candidateDocumentTypes/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"ocrParsedData": {},
"isPaused": false,
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"ocrParsedData": {},
"isPaused": false,
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateDocumentTypes/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateDocumentTypes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateDocumentTypes/{id}
Body parameter
{
"ocrParsedData": {},
"isPaused": false,
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
ocrParsedData | body | object | false | Candidate Document Type parsed data |
isPaused | body | boolean | false | Cancels the automatic confirm of the document if the uploading is not confirmed manually. |
filename | body | string | false | Document type filename. It can include dynamic fields like {candidateFirstname} |
comment | body | string | false | Candidate Document Type comment |
commentType | body | candidateDocumentTypeCommentType | false | Candidate document type comment type |
mandatory | body | boolean | false | It says that Candidate Document Type is mandatory or optional for the candidate |
folder | body | string | false | Candidate Document Type files folder name |
Enumerated Values
Parameter | Value |
---|---|
commentType | info |
commentType | success |
commentType | warning |
commentType | danger |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"isPaused": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentType |
Delete candidate document type by {{id}}
Code samples
DELETE https://api.checkhub.io/candidateDocumentTypes/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateDocumentTypes/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateDocumentTypes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateDocumentTypes/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Archive candidate document types
Code samples
POST https://api.checkhub.io/candidateDocumentTypes/archive HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/zip
const inputBody = '{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/zip',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/archive',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/zip',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/archive',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/zip',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateDocumentTypes/archive', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/zip',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateDocumentTypes/archive',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateDocumentTypes/archive
Body parameter
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate Document type collection order |
filter[accountId] | query | UUID_V4 | false | Filter result by candidate account id 'accountId' |
filter[candidateId] | query | UUID_V4 | false | Filter result by candidate id 'candidateId' |
filter[candidateEmail] | query | string | false | Filter result by candidate 'email' |
filter[candidateArchived] | query | boolean | false | Filter result by candidate 'archived' |
filter[searchText] | query | string | false | Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name') |
filter[customStatuses][] | query | candidateDocumentTypeStatus | false | Filter result by custom statuses (or) |
ids | body | [UUID_V4] | false | Array of candidate document type ids |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[customStatuses][] | provided |
filter[customStatuses][] | pending |
filter[customStatuses][] | validated |
filter[customStatuses][] | expired |
filter[customStatuses][] | rejected |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Download ZIP archive file with candidate documents | string |
Export candidate document types
Code samples
POST https://api.checkhub.io/candidateDocumentTypes/export HTTP/1.1
Host: api.checkhub.io
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
const headers = {
'Accept':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/export',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/export',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateDocumentTypes/export', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateDocumentTypes/export',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateDocumentTypes/export
Body parameter
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate Document type collection order |
filter[accountId] | query | UUID_V4 | false | Filter result by candidate account id 'accountId' |
filter[candidateId] | query | UUID_V4 | false | Filter result by candidate id 'candidateId' |
filter[candidateEmail] | query | string | false | Filter result by candidate 'email' |
filter[candidateArchived] | query | boolean | false | Filter result by candidate 'archived' |
filter[searchText] | query | string | false | Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name') |
filter[customStatuses][] | query | candidateDocumentTypeStatus | false | Filter result by custom statuses (or) |
filter[assigneeId] | query | UUID_V4 | false | Filter result by candidate 'assigneeId' field |
filter[isAssigned] | query | boolean | false | Filter result by 'isAssigned' candidate |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[customStatuses][] | provided |
filter[customStatuses][] | pending |
filter[customStatuses][] | validated |
filter[customStatuses][] | expired |
filter[customStatuses][] | rejected |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Export XLSX file with candidate document types details | string |
Complete single or multiple document upload
Code samples
POST https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateDocumentTypes/{candidateDocumentTypeId}/uploadComplete
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateDocumentTypeId | path | string | true | Candidate document type id which should be used to work with related resources |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Update candidate documents
Code samples
PATCH https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"position": 1
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"position": 1
}
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateDocumentTypes/{candidateDocumentTypeId}/documents
Body parameter
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"position": 1
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateDocumentTypeId | path | string | true | Candidate document type id which should be used to work with related resources |
body | body | candidateDocumentTypeUpdateCandidateDocumentsBody | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "validated",
"isProcessing": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentArray |
Delete candidate documents
Code samples
DELETE https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
{
method: 'DELETE',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateDocumentTypes/{candidateDocumentTypeId}/documents
Body parameter
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateDocumentTypeId | path | string | true | Candidate document type id which should be used to work with related resources |
ids | body | [UUID_V4] | true | Candidate document ids |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Delete candidate document by {{id}}
Code samples
DELETE https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateDocumentTypes/{candidateDocumentTypeId}/documents/{candidateDocumentId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateDocumentTypeId | path | string | true | Candidate document type id which should be used to work with related resources |
candidateDocumentId | path | string | true | Candidate document should be deleted by the 'candidateDocumentId' |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Candidate Resource
Add new resource for candidate
Code samples
POST https://api.checkhub.io/candidateResources HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateResources', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateResources',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateResources
Body parameter
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
resourceId | body | UUID_V4 | true | Unique identifier for the entity |
actions | body | [resourceAction] | false | Resource actions (at least one action required) |
blocking | body | boolean | false | Used for resources that must be completed before starting to work with documents. |
folder | body | string | false | The folder to which the candidate resource will belong. Note: this is only visual separation, does not affect storage in the file system in any way. |
Enumerated Values
Parameter | Value |
---|---|
actions | read |
actions | complete |
actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateResource |
Create or update new resource for candidate
Code samples
PUT https://api.checkhub.io/candidateResources HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"create": [
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"delete": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"create": [
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"delete": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources',
{
method: 'PUT',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.put('https://api.checkhub.io/candidateResources', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.put 'https://api.checkhub.io/candidateResources',
params: {
}, headers: headers
p JSON.parse(result)
PUT /candidateResources
Body parameter
{
"create": [
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"delete": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | candidateResourceChangeBody | false | none |
Example responses
200 Response
{
"created": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateResourceChangeResponse |
Get list of candidate resources
Code samples
GET https://api.checkhub.io/candidateResources HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateResources', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateResources',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateResources
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate resource collection order |
filter[candidateId] | query | UUID_V4 | false | Search by candidateId |
filter[resourceId] | query | UUID_V4 | false | Search by resourceId |
filter[ids][] | query | UUID_V4 | false | Search by candidate resources ids |
filter[blocking] | query | boolean | false | Search by candidate resource blocking property |
filter[locked] | query | boolean | false | Search by candidate resource locked property |
filter[name] | query | string | false | Search by candidate resource name property |
includeResource | query | boolean | false | To include candidate resource 'resource' relation |
includeCandidate | query | boolean | false | To include candidate resource 'candidate' relation |
Enumerated Values
Parameter | Value |
---|---|
order | candidateId asc |
order | candidateId desc |
order | resourceId asc |
order | resourceId desc |
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"resource": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Diploma",
"filename": "diploma_{candidateFirstname}",
"type": "editable",
"language": "en",
"shareCode": "",
"blocking": false,
"version": 1,
"actions": [
"complete",
"download"
],
"content": {
"text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
"file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
"originalFilename": "test.pdf"
},
"fields": [
{
"reference": "firstNameRef",
"name": "First Name",
"contentType": "text",
"prefilled": "{candidateLastname}",
"editable": true,
"mandatory": false
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateResourceFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Deleting many candidate resources from candidate
Code samples
DELETE https://api.checkhub.io/candidateResources HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"locked": false,
"blocking": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"locked": false,
"blocking": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources',
{
method: 'DELETE',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateResources', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateResources',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateResources
Body parameter
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"locked": false,
"blocking": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ids | body | [UUID_V4] | false | [Unique identifier for the entity] |
candidateId | body | UUID_V4 | false | Unique identifier for the entity |
resourceId | body | UUID_V4 | false | Unique identifier for the entity |
locked | body | boolean | false | none |
blocking | body | boolean | false | none |
Example responses
200 Response
{
"count": 1
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | countOfModifiedObjects |
Deleting candidate resource by {{id}} from candidate
Code samples
DELETE https://api.checkhub.io/candidateResources/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateResources/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateResources/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateResources/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get candidate resource by {{id}}
Code samples
GET https://api.checkhub.io/candidateResources/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateResources/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateResources/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateResources/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeResource | query | boolean | false | To include candidate resource 'resource' relation |
includeCandidate | query | boolean | false | To include candidate resource 'candidate' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"resource": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Diploma",
"filename": "diploma_{candidateFirstname}",
"type": "editable",
"language": "en",
"shareCode": "",
"blocking": false,
"version": 1,
"actions": [
"complete",
"download"
],
"content": {
"text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
"file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
"originalFilename": "test.pdf"
},
"fields": [
{
"reference": "firstNameRef",
"name": "First Name",
"contentType": "text",
"prefilled": "{candidateLastname}",
"editable": true,
"mandatory": false
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateResourceFindByIdResponse |
Update candidate resource by {{id}}
Code samples
PATCH https://api.checkhub.io/candidateResources/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateResources/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateResources/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateResources/{id}
Body parameter
{
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
actions | body | [resourceAction] | false | Resource actions (at least one action required) |
blocking | body | boolean | false | Used for resources that must be completed before starting to work with documents. |
folder | body | string | false | The folder to which the candidate resource will belong. Note: this is only visual separation, does not affect storage in the file system in any way. |
Enumerated Values
Parameter | Value |
---|---|
actions | read |
actions | complete |
actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateResource |
Set completed action by candidate
Code samples
PUT https://api.checkhub.io/candidateResources/{id}/{action} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask",
"{field reference for signature}": "data:image/png;base64,iVBORw0KGg"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}/{action}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask",
"{field reference for signature}": "data:image/png;base64,iVBORw0KGg"
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}/{action}',
{
method: 'PUT',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.put('https://api.checkhub.io/candidateResources/{id}/{action}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.put 'https://api.checkhub.io/candidateResources/{id}/{action}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /candidateResources/{id}/{action}
Body parameter
{
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask",
"{field reference for signature}": "data:image/png;base64,iVBORw0KGg"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
action | path | string | true | Action completed by candidate |
fields | body | object | false | Mapping of references and their actual values filled in by the candidate. |
» {field reference for checkbox} | body | boolean | false | The value chosen by the candidate. |
» {field reference for text} | body | string | false | The value entered by the candidate. |
» {field reference for signature} | body | string | false | Base64 signature image. |
Enumerated Values
Parameter | Value |
---|---|
action | read |
action | complete |
action | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"resource": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Diploma",
"filename": "diploma_{candidateFirstname}",
"type": "editable",
"language": "en",
"shareCode": "",
"blocking": false,
"version": 1,
"actions": [
"complete",
"download"
],
"content": {
"text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n",
"file": "resources/5fa52f8d07763975db16e720/4d30393f-eb29-4bb8-ba3e-c40efa79fb00_test.pdf",
"originalFilename": "test.pdf"
},
"fields": [
{
"reference": "firstNameRef",
"name": "First Name",
"contentType": "text",
"prefilled": "{candidateLastname}",
"editable": true,
"mandatory": false
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateResourceFindByIdResponse |
Get candidate editable resource content by candidate resource {{id}}
Code samples
GET https://api.checkhub.io/candidateResources/{id}/text HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}/text',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidateResources/{id}/text',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateResources/{id}/text', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateResources/{id}/text',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateResources/{id}/text
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"text": "<p>It's the contract for Elon Mask.</p>"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateResourceGetEditableContentResponse |
Candidate Form
Create Candidate Form
Code samples
POST https://api.checkhub.io/candidate-forms HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidate-forms', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidate-forms',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidate-forms
Body parameter
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
formId | body | UUID_V4 | true | Unique identifier for the entity |
actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | body | boolean | false | Is candidate form mandatory |
fileId | body | UUID_V4 | false | Unique identifier for the entity |
signatureId | body | UUID_V4 | false | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
actions | read |
actions | complete |
actions | eSign |
actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateForm |
Get Candidate Form Collection
Code samples
GET https://api.checkhub.io/candidate-forms HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-forms', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-forms',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-forms
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate Form collection order |
filter[ids][] | query | UUID_V4 | false | Search by candidate form ids |
filter[name] | query | string | false | Search by candidate form name |
filter[candidateId] | query | UUID_V4 | false | Search by candidateId |
filter[formId] | query | UUID_V4 | false | Search by formId |
filter[createdAtFrom] | query | DateISO | false | Filter result by creation time >= |
filter[createdAtTo] | query | DateISO | false | Filter result by creation time <= |
filter[updatedAtFrom] | query | DateISO | false | Filter result by update time >= |
filter[updatedAtTo] | query | DateISO | false | Filter result by update time <= |
filter[assigneeId] | query | UUID_V4 | false | Filter result by candidate 'assigneeId' field |
filter[isAssigned] | query | boolean | false | Filter result by 'isAssigned' candidate |
includeForm | query | boolean | false | You can include 'form' relation |
includeCandidate | query | boolean | false | You can include 'candidate' relation |
includeAdditions | query | boolean | false | You can include addition candidate forms 'additions' relation |
includeAdditionsData | query | boolean | false | You can include addition candidate forms 'additions' with addition candidate form data relation |
includeCandidateAssignee | query | boolean | false | You can include candidate 'assignee' relation |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"additions": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFormFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Get Candidate Form by {{id}}
Code samples
GET https://api.checkhub.io/candidate-forms/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-forms/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-forms/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeForm | query | boolean | false | You can include 'form' relation |
includeCandidate | query | boolean | false | You can include 'candidate' relation |
includeData | query | boolean | false | You can include 'data' relation |
includeAdditions | query | boolean | false | You can include addition candidate forms 'additions' relation |
includeAdditionsData | query | boolean | false | You can include addition candidate forms 'additions' with addition candidate form data relation |
includeCandidateAssignee | query | boolean | false | You can include candidate 'assignee' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"data": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fields": {},
"context": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"additions": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFormFindByIdResponse |
Update Candidate Form by {{id}}
Code samples
PATCH https://api.checkhub.io/candidate-forms/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"actions": [
"complete",
"download"
],
"isMandatory": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"actions": [
"complete",
"download"
],
"isMandatory": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidate-forms/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidate-forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidate-forms/{id}
Body parameter
{
"actions": [
"complete",
"download"
],
"isMandatory": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
actions | body | [formAction] | false | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | body | boolean | false | Is Form mandatory |
Enumerated Values
Parameter | Value |
---|---|
actions | read |
actions | complete |
actions | eSign |
actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateForm |
Delete Candidate Form by {{id}}
Code samples
DELETE https://api.checkhub.io/candidate-forms/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidate-forms/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidate-forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidate-forms/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFormSuccessResponse |
Set completed action by candidate
Code samples
PUT https://api.checkhub.io/candidate-forms/{id}/{action} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}/{action}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask"
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}/{action}',
{
method: 'PUT',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.put('https://api.checkhub.io/candidate-forms/{id}/{action}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.put 'https://api.checkhub.io/candidate-forms/{id}/{action}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /candidate-forms/{id}/{action}
Body parameter
{
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
action | path | string | true | Action by candidate |
fields | body | object | false | Mapping of references and their actual values filled in by the candidate. |
» {field reference for checkbox} | body | boolean | false | The value chosen by the candidate. |
» {field reference for text} | body | string | false | The value entered by the candidate. |
Enumerated Values
Parameter | Value |
---|---|
action | read |
action | complete |
action | eSign |
action | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateForm |
Candidate Form Data
Get candidate form data by {{id}}
Code samples
GET https://api.checkhub.io/candidate-form-data/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-form-data/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-form-data/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-form-data/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-form-data/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-form-data/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fields": {},
"context": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFormData |
Candidate Preset
Get candidate preset collection
Code samples
GET https://api.checkhub.io/candidatePresets HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidatePresets', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidatePresets',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidatePresets
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Candidate Preset collection order |
filter[name] | query | string | false | Search by candidate preset name |
filter[reference] | query | string | false | Search by candidate preset reference |
includeCompany | query | boolean | false | To include candidate preset 'company' relation |
includeShared | query | boolean | false | To include candidate presets from the companies of the same company group |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | reference asc |
order | reference desc |
order | createdAt asc |
order | createdAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidatePresetFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create candidate preset
Code samples
POST https://api.checkhub.io/candidatePresets HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidatePresets', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidatePresets',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidatePresets
Body parameter
{
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Candidate Preset name |
reference | body | string | false | Candidate Preset reference |
docTypes | body | [candidatePresetDocType] | false | Documents to be applied to the candidate. |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» name | body | string | false | Alternative name for document (for example, if added several identical document types.) |
» comment | body | string | false | Comment for document |
» folder | body | string | false | Folder for document |
» commentType | body | candidateDocumentTypeCommentType | false | Candidate document type comment type |
» mandatory | body | boolean | false | Folder for document |
resources | body | [candidatePresetResource] | false | Resources to be applied to the candidate. |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [resourceAction] | true | Resource actions (at least one action required) |
forms | body | [candidatePresetForm] | false | Forms to be applied to the candidate. |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
» isMandatory | body | boolean | true | It says that form is mandatory or optional for the candidate. |
» signatureId | body | UUID_V4 | false | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
» commentType | info |
» commentType | success |
» commentType | warning |
» commentType | danger |
» actions | read |
» actions | complete |
» actions | download |
» actions | read |
» actions | complete |
» actions | eSign |
» actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidatePreset |
Get candidate preset by {{id}}
Code samples
GET https://api.checkhub.io/candidatePresets/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidatePresets/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidatePresets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidatePresets/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCompany | query | boolean | false | To include candidate preset 'company' relation |
includeShared | query | boolean | false | To include candidate presets from the companies of the same company group |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidatePresetFindByIdResponse |
Update candidate preset by {{id}}
Code samples
PATCH https://api.checkhub.io/candidatePresets/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidatePresets/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidatePresets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidatePresets/{id}
Body parameter
{
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | true | Candidate Preset name |
reference | body | string | false | Candidate Preset reference |
docTypes | body | [candidatePresetDocType] | false | Documents to be applied to the candidate. |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» name | body | string | false | Alternative name for document (for example, if added several identical document types.) |
» comment | body | string | false | Comment for document |
» folder | body | string | false | Folder for document |
» commentType | body | candidateDocumentTypeCommentType | false | Candidate document type comment type |
» mandatory | body | boolean | false | Folder for document |
resources | body | [candidatePresetResource] | false | Resources to be applied to the candidate. |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [resourceAction] | true | Resource actions (at least one action required) |
forms | body | [candidatePresetForm] | false | Forms to be applied to the candidate. |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
» isMandatory | body | boolean | true | It says that form is mandatory or optional for the candidate. |
» signatureId | body | UUID_V4 | false | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
» commentType | info |
» commentType | success |
» commentType | warning |
» commentType | danger |
» actions | read |
» actions | complete |
» actions | download |
» actions | read |
» actions | complete |
» actions | eSign |
» actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome set for NL",
"reference": "WELCOME_SET",
"docTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidatePreset |
Delete candidate preset by {{id}}
Code samples
DELETE https://api.checkhub.io/candidatePresets/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidatePresets/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidatePresets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidatePresets/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Company
Get own company information
Code samples
GET https://api.checkhub.io/companies/me HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json'
};
fetch('https://api.checkhub.io/companies/me',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json'
};
fetch('https://api.checkhub.io/companies/me',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('https://api.checkhub.io/companies/me', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.checkhub.io/companies/me',
params: {
}, headers: headers
p JSON.parse(result)
GET /companies/me
The method allows you to get information about the company that owns the token.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
includePolicy | query | boolean | false | You can include company 'policy' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companyFindByMeResponse |
Edit company by {{id}}
Code samples
PATCH https://api.checkhub.io/companies/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/companies/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/companies/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/companies/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/companies/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /companies/{id}
Body parameter
{
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
body | body | companyEditByIdRequest | false | none |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>Hi, this is our policy!</p>",
"nl": "<p>Hoi, this is our policy!</p>",
"fr": "<p>Salut, this is our policy!</p>",
"de": "<p>Hallo, this is our policy!</p>",
"it": "<p>Hallo, this is our policy!</p>"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companyEditByIdResponse |
Validate Company reference
Code samples
POST https://api.checkhub.io/companies/validate-reference HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"reference": "example value",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"model": "candidate"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/companies/validate-reference',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"reference": "example value",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"model": "candidate"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/companies/validate-reference',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/companies/validate-reference', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/companies/validate-reference',
params: {
}, headers: headers
p JSON.parse(result)
POST /companies/validate-reference
Body parameter
{
"reference": "example value",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"model": "candidate"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | companyValidateReference | false | none |
Example responses
200 Response
{
"isValid": true,
"isValidString": true,
"isUnique": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companyValidateReferenceResponse |
Company Signature Role
Get company signature role collection
Code samples
GET https://api.checkhub.io/company-signature-roles HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/company-signature-roles', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/company-signature-roles',
params: {
}, headers: headers
p JSON.parse(result)
GET /company-signature-roles
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response default: 10 |
skip | query | number | false | Number of items skipped during the selection. default: 0 |
order | query | string | false | Company signature role collection order |
includeEntity | query | boolean | false | To include company signature role entity. It could be 'candidate' or 'adminUser' relation |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"adminUser": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companySignatureRoleFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create company signature role
Code samples
POST https://api.checkhub.io/company-signature-roles HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/company-signature-roles', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/company-signature-roles',
params: {
}, headers: headers
p JSON.parse(result)
POST /company-signature-roles
Body parameter
{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Company signature role name |
entity | body | companySignatureRoleEntity | true | none |
entityId | body | UUID_V4 | true | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
entity | adminUser |
entity | candidate |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companySignatureRole |
Get company signature role by {{id}}
Code samples
GET https://api.checkhub.io/company-signature-roles/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/company-signature-roles/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/company-signature-roles/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /company-signature-roles/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76