Vitay.io API Reference
Welcome to the Vitay API documentation.
We implement the JSON API specification. Feel free to check the documenation here: jsonapi.org
You must add the Bearer token in your request. You must use the login endpoint to get this token.
The sandbox API is staging.api.vitay.io
Keep in mind the Vitay API documentation is still in beta. Some endpoints are subject to major refactoring due to RESTFul and JSON:API best practices implementation.
© 2023 Vitay.ioAPI Endpoint
https://api.vitay.io/api
Request Content-Types: application/json
Schemes: https
Version: 3.7.3
Authentication
Please refer to oauth in the side menu.
api
Show ping pong
Check if the server is responding
Pong
Set up environment variables
Set up environment variables
Return all variables for postman
reference_requests
Index all reference requests
Index all reference requests
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"notes": "string",
"created_at": "string",
"min_manager_references": "string",
"filled": "string",
"reminder": {
"next_scheduled_at": "string",
"latest_sent_at": "string",
"count": "number",
"count_exceeded": "string",
"rate_exceeded": "string"
}
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
},
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
Create reference request
Create a reference request. An email and a text message is sent to all references saved
- data: object
-
- type: string ReferenceRequest
- attributes: object
-
- notes: string
- min_manager_references: string
- relationships: object
-
- question_set: object
-
- type: string RerefenceRequest
- id: string
- candidate: object
-
- type: string RerefenceRequest
- id: string
Request Content-Types: application/json
Request Example
{
"data": {
"type": "string",
"attributes": {
"notes": "string",
"min_manager_references": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"notes": "string",
"created_at": "string",
"min_manager_references": "string",
"filled": "string",
"reminder": {
"next_scheduled_at": "string",
"latest_sent_at": "string",
"count": "number",
"count_exceeded": "string",
"rate_exceeded": "string"
}
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Send reminder
Send reminder (email and text message) to candidate
Identifier of the reminder
OK
Response Example (200 OK)
{
"data": {
"detail": "string"
}
}
activities
Index all activities
Index all activities
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"id": "string",
"trackable_type": "string",
"trackable_id": "string",
"owner_type": "string",
"owner_id": "string",
"recipient_type": "string",
"recipient_id": "string",
"key": "string",
"parameters": "string",
"created_at": "string",
"updated_at": "string"
},
"relationships": {
"trackable": {
"type": "string",
"id": "string"
},
"owner": {
"type": "string",
"id": "string"
},
"recipient": {
"type": "string",
"id": "string"
}
}
},
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
users
Index all users
Index all users
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string"
},
"relationships": {
"identifiable": {
"type": "string",
"id": "string"
}
}
},
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
Show specific user
Show specific user
Identifier of the user
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string"
},
"relationships": {
"identifiable": {
"type": "string",
"id": "string"
}
}
}
}
Show logged user
Show logged user
Identifier of the user
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string"
},
"relationships": {
"identifiable": {
"type": "string",
"id": "string"
}
}
}
}
answers
Show specific answer
Show specific answer
Identifier of the answer
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"question": "string",
"value": "string",
"scale": "number",
"language": "string",
"category": "string",
"type": "string",
"comment": "string"
},
"relationships": {
"question": "string",
"value": "string",
"scale": "number",
"language": "string",
"category": "string",
"type": "string",
"comment": "string"
}
}
}
Update an answer
Update an answer
Identifier of the answer
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"question": "string",
"value": "string",
"scale": "number",
"language": "string",
"category": "string",
"type": "string",
"comment": "string"
},
"relationships": {
"answer_set": {
"type": "string",
"id": "string"
}
}
}
}
hiring_firms
Index all hiring firms
Index all hiring firms
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string",
"logo_url": "string"
}
}
],
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
Show specific hiring firm
Show specific hiring firm
Identifier of the hiring firm
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string",
"logo_url": "string"
}
}
}
Update hiring firm
Update hiring firm
- data: object
-
- id: string
- type: string HiringFirm
- attributes: object
-
- name: string
Identifier of the hiring firm
Request Content-Types: application/json
Request Example
{
"data": {
"id": "string",
"type": "string",
"attributes": {
"name": "string"
}
}
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string",
"logo_url": "string"
}
}
}
Delete hiring firm
Delete hiring firm
- data: object
-
- id: string
- type: string HiringFirm
Identifier of the hiring firm
Request Content-Types: application/json
Request Example
{
"data": {
"id": "string",
"type": "string"
}
}
OK
Response Example (200 OK)
{
"data": "object"
}
Update hiring firm logo
Update hiring firm logo
- logo_file: file
Identifier of the hiring firm
Request Content-Types: application/json
Request Example
{
"logo_file": "file"
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string",
"logo_url": "string"
}
}
}
Show specific hiring firm analytics
Show specific hiring firm analytics
Identifier of the hiring firm
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"total_candidates": "number",
"total_references": "number",
"completed_references": "number",
"avg_reference_completion_time": "number",
"avg_candidates_score": "number",
"candidate_count_by_date": [
{
"date": "number"
}
],
"reference_count_by_date": [
{
"date": "number"
}
],
"top_recruiters": [
{
"name": "string",
"total_references": "number",
"completed_references": "number"
}
]
}
}
}
profiles
Show specific candidate profile
Show specific candidate profile
Identifier of the profile
OK
Response Example (200 OK)
{
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"id": "string",
"title": "string",
"bio": "string",
"job_title": "string",
"street_address": "string",
"city": "string",
"province": "string",
"is_active": "string",
"created_at": "string",
"updated_at": "string",
"public_profile_url": "string",
"industry": "string",
"picture_url": "string",
"has_user": "string"
},
"relationships": {
"user": {
"type": "string",
"id": "string"
},
"experiences": [
{
"type": "string",
"id": "string"
}
],
"educations": [
{
"type": "string",
"id": "string"
}
]
}
}
]
}
questions
Index all questions
Index all questions
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"type": "string",
"category": "string",
"order": "number",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
},
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
Create question
Create a question
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"type": "string",
"category": "string",
"order": "number",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Show specific question
Show specific question
Identifier of the question
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"type": "string",
"category": "string",
"order": "number",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Update a question
Update a question
Identifier of the question
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"type": "string",
"category": "string",
"order": "number",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Delete a question
Delete a question
Identifier of the question
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"type": "string",
"category": "string",
"order": "number",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
verifications
Send reminder
Send reminder (email and text message) to the verifier
Identifier of the reminder
OK
Response Example (200 OK)
{
"data": {
"detail": "string"
}
}
recruiters
Index all recruiters
Index all recruiters
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"id": "string",
"hiring_firm_id": "string",
"is_active": "string",
"is_active_hf": "string",
"created_at": "string",
"notifications": "string",
"is_root": "string"
},
"relationships": {
"hiring_firm": {
"type": "string",
"id": "string"
},
"user": {
"type": "string",
"id": "string"
},
"candidates": [
{
"type": "string",
"id": "string"
}
]
}
}
],
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
Show specific recruiter
Show specific recruiter
Identifier of the recruiter
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"id": "string",
"hiring_firm_id": "string",
"is_active": "string",
"is_active_hf": "string",
"created_at": "string",
"notifications": "string",
"is_root": "string"
},
"relationships": {
"hiring_firm": {
"type": "string",
"id": "string"
},
"user": {
"type": "string",
"id": "string"
},
"candidates": [
{
"type": "string",
"id": "string"
}
]
}
}
}
Update a recruiter
Update a recruiter
Identifier of the recruiter
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"id": "string",
"hiring_firm_id": "string",
"is_active": "string",
"is_active_hf": "string",
"created_at": "string",
"notifications": "string",
"is_root": "string"
},
"relationships": {
"hiring_firm": {
"type": "string",
"id": "string"
},
"user": {
"type": "string",
"id": "string"
},
"candidates": [
{
"type": "string",
"id": "string"
}
]
}
}
}
Delete a recruiter
Delete a recruiter
Identifier of the recruiter
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"id": "string",
"hiring_firm_id": "string",
"is_active": "string",
"is_active_hf": "string",
"created_at": "string",
"notifications": "string",
"is_root": "string"
},
"relationships": {
"hiring_firm": {
"type": "string",
"id": "string"
},
"user": {
"type": "string",
"id": "string"
},
"candidates": [
{
"type": "string",
"id": "string"
}
]
}
}
}
Show specific recruiter analytics
Show specific recruiter analytics
Identifier of the recruiter
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"id": "string",
"hiring_firm_id": "string",
"is_active": "string",
"is_active_hf": "string",
"created_at": "string",
"notifications": "string",
"is_root": "string",
"total_candidates": "number",
"total_references": "number",
"completed_references": "number",
"avg_reference_completion_time": "number",
"avg_candidates_score": "number"
},
"relationships": {
"hiring_firm": {
"type": "string",
"id": "string"
},
"user": {
"type": "string",
"id": "string"
},
"candidates": [
{
"type": "string",
"id": "string"
}
]
}
}
}
Create recruiter (from root recruiter)
Create a recruiter (from root recruiter)
- data: object
-
- attributes: object
-
- hiring_firm_id: string
- relationships: object
-
- user: object
-
- attributes: object
-
- emai: string
Request Content-Types: application/json
Request Example
{
"data": {
"attributes": {
"hiring_firm_id": "string"
},
"relationships": {
"user": {
"attributes": {
"emai": "string"
}
}
}
}
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"id": "string",
"hiring_firm_id": "string",
"is_active": "string",
"is_active_hf": "string",
"created_at": "string",
"notifications": "string",
"is_root": "string"
},
"relationships": {
"hiring_firm": {
"type": "string",
"id": "string"
},
"user": {
"type": "string",
"id": "string"
},
"candidates": [
{
"type": "string",
"id": "string"
}
]
}
}
}
candidates
Index all candidates
Index all candidates
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"internal_id": "string",
"notes": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"country_code": "string",
"phone": "string",
"score": "number"
},
"relationships": {
"references": [
{
"type": "string",
"id": "string"
}
],
"added_by": {
"type": "string",
"id": "string",
"filled": "string"
},
"reference_requests": [
{
"type": "string",
"id": "string",
"filled": "string"
}
],
"metadatum": {
"type": "string",
"id": "string"
}
}
}
],
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
Create a candidate
Create a candidate
- data: object
-
- attributes: object
-
- internal_id: string
-
General-purpose Internal ID
- notes: string
- first_name: string
-
First name of the candidate
- last_name: string
-
Last name name of the candidate
- email: string
-
Email of the candidate
- country_code: string
- phone: string
- score: number
Request Content-Types: application/json
Request Example
{
"data": {
"attributes": {
"internal_id": "string",
"notes": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"country_code": "string",
"phone": "string",
"score": "number"
}
}
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"internal_id": "string",
"notes": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"country_code": "string",
"phone": "string",
"score": "number"
},
"relationships": {
"references": [
{
"type": "string",
"id": "string"
}
],
"added_by": {
"type": "string",
"id": "string",
"filled": "string"
},
"reference_requests": [
{
"type": "string",
"id": "string",
"filled": "string"
}
],
"metadatum": {
"type": "string",
"id": "string"
}
}
}
}
Show specific candidate
Show specific candidate
Identifier of the candidate
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"internal_id": "string",
"notes": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"country_code": "string",
"phone": "string",
"score": "number"
},
"relationships": {
"references": [
{
"type": "string",
"id": "string"
}
],
"added_by": {
"type": "string",
"id": "string",
"filled": "string"
},
"reference_requests": [
{
"type": "string",
"id": "string",
"filled": "string"
}
],
"metadatum": {
"type": "string",
"id": "string"
}
}
}
}
Update a candidate
Update a candidate
Identifier of the candidate
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"internal_id": "string",
"notes": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"country_code": "string",
"phone": "string",
"score": "number"
},
"relationships": {
"references": [
{
"type": "string",
"id": "string"
}
],
"added_by": {
"type": "string",
"id": "string",
"filled": "string"
},
"reference_requests": [
{
"type": "string",
"id": "string",
"filled": "string"
}
],
"metadatum": {
"type": "string",
"id": "string"
}
}
}
}
Delete a candidate
Delete a candidate
Identifier of the candidate
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"internal_id": "string",
"notes": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"country_code": "string",
"phone": "string",
"score": "number"
},
"relationships": {
"references": [
{
"type": "string",
"id": "string"
}
],
"added_by": {
"type": "string",
"id": "string",
"filled": "string"
},
"reference_requests": [
{
"type": "string",
"id": "string",
"filled": "string"
}
],
"metadatum": {
"type": "string",
"id": "string"
}
}
}
}
question_sets
Index all question sets
Index all question sets
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"title": "string",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Create question set
Create question set
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"title": "string",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Show specific question set
Show specific question set
Identifier of the question set
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"title": "string",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Update a question set
Update a question set
Identifier of the question set
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"title": "string",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Delete a question set
Delete a question set
Identifier of the question set
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"title": "string",
"language": "string"
},
"relationships": {
"question_set": {
"type": "string",
"id": "string"
},
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
references
Create reference
Create a reference
- data: object
-
- type: string Reference
- id: string
- attributes: object
-
- internal_id: string
- email: string
- first_name: string
- last_name: string
- phone: string
- country_code: string
Request Content-Types: application/json
Request Example
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"internal_id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string"
}
}
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"created_at": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string",
"is_active_hf": "string",
"relationship": "string",
"permission_share_clients": "string",
"contact_type": "string",
"permission_share_candidate": "string",
"language": "string",
"company_name": "string",
"is_pending": "string",
"filled": "string",
"filled_at": "string",
"requested_by_id": "string",
"requested_by": "string",
"score": "string",
"reminder": {
"next_scheduled_at": "string",
"latest_sent_at": "string",
"count": "number",
"count_exceeded": "string",
"rate_exceeded": "string"
}
},
"relationships": {
"question_set": [
{
"type": "string",
"id": "string"
}
],
"candidate": {
"type": "string",
"id": "string"
}
}
}
}
Index all references
Index all references
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"created_at": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string",
"is_active_hf": "string",
"relationship": "string",
"permission_share_clients": "string",
"contact_type": "string",
"permission_share_candidate": "string",
"language": "string",
"company_name": "string",
"is_pending": "string",
"filled": "string",
"filled_at": "string",
"requested_by_id": "string",
"requested_by": "string",
"score": "string",
"reminder": {
"next_scheduled_at": "string",
"latest_sent_at": "string",
"count": "number",
"count_exceeded": "string",
"rate_exceeded": "string"
}
},
"relationships": {
"answer_set": {
"type": "string",
"id": "string"
},
"question_set": [
{
"type": "string",
"id": "string"
}
],
"candidate": {
"type": "string",
"id": "string"
},
"metadatum": {
"type": "string",
"id": "string"
}
}
},
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
Update a reference
Update a reference
Identifier of the reference
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"created_at": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string",
"is_active_hf": "string",
"relationship": "string",
"permission_share_clients": "string",
"contact_type": "string",
"permission_share_candidate": "string",
"language": "string",
"company_name": "string",
"is_pending": "string",
"filled": "string",
"filled_at": "string",
"requested_by_id": "string",
"requested_by": "string",
"score": "string",
"reminder": {
"next_scheduled_at": "string",
"latest_sent_at": "string",
"count": "number",
"count_exceeded": "string",
"rate_exceeded": "string"
}
}
}
}
Show specific reference
Show specific reference
(no description)
Invalid Reference
Delete a reference
Delete a reference
Identifier of the reference
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"created_at": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string",
"is_active_hf": "string",
"relationship": "string",
"permission_share_clients": "string",
"contact_type": "string",
"permission_share_candidate": "string",
"language": "string",
"company_name": "string",
"is_pending": "string",
"filled": "string",
"filled_at": "string",
"requested_by_id": "string",
"requested_by": "string",
"score": "string",
"reminder": {
"next_scheduled_at": "string",
"latest_sent_at": "string",
"count": "number",
"count_exceeded": "string",
"rate_exceeded": "string"
}
},
"relationships": {
"answer_set": {
"type": "string",
"id": "string"
},
"question_set": [
{
"type": "string",
"id": "string"
}
],
"candidate": {
"type": "string",
"id": "string"
},
"metadatum": {
"type": "string",
"id": "string"
}
}
}
}
Show specific reference
Show specific reference
Identifier of the reference
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"created_at": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string",
"is_active_hf": "string",
"relationship": "string",
"permission_share_clients": "string",
"contact_type": "string",
"permission_share_candidate": "string",
"language": "string",
"company_name": "string",
"is_pending": "string",
"filled": "string",
"filled_at": "string",
"requested_by_id": "string",
"requested_by": "string",
"score": "string",
"reminder": {
"next_scheduled_at": "string",
"latest_sent_at": "string",
"count": "number",
"count_exceeded": "string",
"rate_exceeded": "string"
}
},
"relationships": {
"answer_set": {
"type": "string",
"id": "string"
},
"question_set": [
{
"type": "string",
"id": "string"
}
],
"candidate": {
"type": "string",
"id": "string"
},
"metadatum": {
"type": "string",
"id": "string"
}
}
}
}
Create reference answers
Create a reference answers to complete the question set previously sent
- data: object
-
- type: string Reference
- id: string
- attributes: object
-
- answers: string[]
-
string
Request Content-Types: application/json
Request Example
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"answers": [
"string"
]
}
}
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string",
"created_at": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"country_code": "string",
"is_active": "string",
"is_active_hf": "string",
"relationship": "string",
"permission_share_clients": "string",
"contact_type": "string",
"permission_share_candidate": "string",
"language": "string",
"company_name": "string",
"is_pending": "string",
"filled": "string",
"filled_at": "string",
"requested_by_id": "string",
"requested_by": "string",
"score": "string",
"reminder": {
"next_scheduled_at": "string",
"latest_sent_at": "string",
"count": "number",
"count_exceeded": "string",
"rate_exceeded": "string"
}
},
"relationships": {
"answer_set": {
"type": "string",
"id": "string"
},
"question_set": [
{
"type": "string",
"id": "string"
}
],
"candidate": {
"type": "string",
"id": "string"
},
"metadatum": {
"type": "string",
"id": "string"
}
}
}
}
Send reminder
Send reminder (email and text message) to reference
Identifier of the reference
OK
Response Example (200 OK)
{
"data": {
"detail": "string"
}
}
docx
Download PDF references report
Download PDF report
(no description)
Identifier of the candidate/reference/invoice/resume
OK
metadata
Index all metadata
Index all metadata
(no description)
(no description)
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"identifiable": "string",
"ip_address": "string",
"browser": "string",
"browser_version": "string",
"os": "string",
"os_version": "string",
"user_agent": "string",
"created_at": "string",
"updated_at": "string"
},
"relationships": {
"identifiable": {
"type": "string",
"id": "string"
}
}
},
"pagination": {
"current_page": "number",
"total_pages": "number",
"total_entries": "number",
"page_size": "number"
}
}
Create a metadataum
Create a metadataum
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"identifiable": {
"type": "string",
"id": "string"
}
},
"relationships": {
"identifiable": {
"type": "string",
"id": "string"
}
}
}
}
oauth
Log in user
Log in user
- email: string
-
User email
- password: string
-
User password
Request Content-Types: application/json
Request Example
{
"email": "string",
"password": "string"
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"token": "string"
}
}
}
Find reset password
Receive an email to reset the user password
User email
OK
Response Example (200 OK)
{
"data": {
"attributes": {
"token": "string"
}
}
}
Request reset password
Receive an email to reset the user password
- email: string
-
User email
Request Content-Types: application/json
Request Example
{
"email": "string"
}
OK
Response Example (200 OK)
{
"data": {
"key": "string",
"type": "string",
"id": "string",
"attributes": {
"email": "string"
}
}
}
Update password
Update user password
- email: string
-
User email
- password: string
-
New password
- reset_key: string
-
Reset key from
Request Content-Types: application/json
Request Example
{
"email": "string",
"password": "string",
"reset_key": "string"
}
OK
Response Example (200 OK)
{
"data": {
"type": "string",
"id": "string",
"attributes": {
"email": "string"
}
}
}