logo
API docs by Redocly

Vitay.io (3.7.3)

Download OpenAPI specification:Download

Welcome to the Vitay API documentation.

⚠️ Important: You must add the Bearer token in your requests. Please use the login endpoint (under the oauth menu) to get this token.

The sandbox API URL is staging.api.vitay.io

© 2023 Vitay.io

question_sets

Index all question sets

Index all question sets

Responses

Create question set

Create question set

Responses

Show specific question set

Show specific question set

path Parameters
id
required
string

Identifier of the question set

Responses

Update a question set

Update a question set

path Parameters
id
required
string

Identifier of the question set

Responses

Delete a question set

Delete a question set

path Parameters
id
required
string

Identifier of the question set

Responses

verifications

Send reminder

Send reminder (email and text message) to the verifier

path Parameters
id
required
string

Identifier of the reminder

Responses

questions

Index all questions

Index all questions

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

Create question

Create a question

Responses

Show specific question

Show specific question

path Parameters
id
required
string

Identifier of the question

Responses

Update a question

Update a question

path Parameters
id
required
string

Identifier of the question

Responses

Delete a question

Delete a question

path Parameters
id
required
string

Identifier of the question

Responses

users

Index all users

Index all users

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

Show specific user

Show specific user

path Parameters
id
required
string

Identifier of the user

Responses

Show logged user

Show logged user

query Parameters
id
required
string

Identifier of the user

Responses

references

Create reference

Create a reference

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Index all references

Index all references

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

Update a reference

Update a reference

path Parameters
id
required
string

Identifier of the reference

Responses

Show specific reference

Show specific reference

path Parameters
id
required
number

Responses

Delete a reference

Delete a reference

path Parameters
id
required
string

Identifier of the reference

Responses

Show specific reference

Show specific reference

path Parameters
id
required
string

Identifier of the reference

Responses

Create reference answers

Create a reference answers to complete the question set previously sent

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Send reminder

Send reminder (email and text message) to reference

path Parameters
id
required
string

Identifier of the reference

Responses

candidates

Index all candidates

Index all candidates

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

Create a candidate

Create a candidate

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Show specific candidate

Show specific candidate

path Parameters
id
required
string

Identifier of the candidate

Responses

Update a candidate

Update a candidate

path Parameters
id
required
string

Identifier of the candidate

Responses

Delete a candidate

Delete a candidate

path Parameters
id
required
string

Identifier of the candidate

Responses

profiles

Show specific candidate profile

Show specific candidate profile

path Parameters
id
required
string

Identifier of the profile

Responses

answers

Show specific answer

Show specific answer

path Parameters
id
required
string

Identifier of the answer

Responses

Update an answer

Update an answer

path Parameters
id
required
string

Identifier of the answer

Responses

activities

Index all activities

Index all activities

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

reference_requests

Index all reference requests

Index all reference requests

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

Create reference request

Create a reference request. An email and a text message is sent to all references saved

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Send reminder

Send reminder (email and text message) to candidate

path Parameters
id
required
string

Identifier of the reminder

Responses

hiring_firms

Index all hiring firms

Index all hiring firms

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

Show specific hiring firm

Show specific hiring firm

path Parameters
id
required
string

Identifier of the hiring firm

Responses

Update hiring firm

Update hiring firm

path Parameters
id
required
string

Identifier of the hiring firm

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Delete hiring firm

Delete hiring firm

path Parameters
id
required
string

Identifier of the hiring firm

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Show specific hiring firm analytics

Show specific hiring firm analytics

path Parameters
id
required
string

Identifier of the hiring firm

Responses

recruiters

Index all recruiters

Index all recruiters

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

Show specific recruiter

Show specific recruiter

path Parameters
id
required
string

Identifier of the recruiter

Responses

Update a recruiter

Update a recruiter

path Parameters
id
required
string

Identifier of the recruiter

Responses

Delete a recruiter

Delete a recruiter

path Parameters
id
required
string

Identifier of the recruiter

Responses

Show specific recruiter analytics

Show specific recruiter analytics

path Parameters
id
required
string

Identifier of the recruiter

Responses

Create recruiter (from root recruiter)

Create a recruiter (from root recruiter)

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

metadata

Index all metadata

Index all metadata

query Parameters
page[page]
number
Default: 1
page[page_size]
number
Default: 15

Responses

Create a metadataum

Create a metadataum

Responses

pdf

Download PDF references report

Download PDF report

query Parameters
id
required
string

Identifier of the candidate/reference/invoice/resume

type
required
string
Enum: "candidates" "invoices" "resumes" "references"

Responses

oauth

Log in user

Log in user

Request Body schema: application/json
email
required
string

User email

password
required
string

User password

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Find reset password

Receive an email to reset the user password

query Parameters
email
required
string

User email

Responses

Request reset password

Receive an email to reset the user password

Request Body schema: application/json
email
required
string

User email

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Update password

Update user password

Request Body schema: application/json
email
required
string

User email

password
required
string

New password

reset_key
required
string

Reset key from

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "reset_key": "string"
}