{
"openapi": "3.0.0",
"info": {
"title": "Kandio",
"description": "Welcome to the Kandio API documentation.
\r\nKandio is a curated skill-testing marketplace with assessment tests made by the world’s top 0.1%. Hire proven candidates and avoid empty talk.\r\nThe API allows you to connect our platform with your system and send data both ways.
\r\nOur typical API clients are other platforms such as: job sites, applicant tracking services and large scale HR departments.",
"termsOfService": "https://kand.io/terms-condition#terms-of-services",
"contact": {
"email": "info@kand.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.0"
},
"paths": {
"/{organization}/assessments": {
"get": {
"tags": [
"assessment"
],
"summary": "Get list of all the assessments in the organization",
"description": "Return a collection of assessments",
"operationId": "index",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Assessments collection after a successful request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Assessment"
}
}
}
}
},
"400": {
"description": "Bad request"
}
},
"security": [
{
"passport": []
}
]
}
},
"/{organization}/assessments/{assessment}": {
"get": {
"tags": [
"assessment"
],
"summary": "Find assessment by slug",
"description": "Returns a single assessment",
"operationId": "show",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "assessment",
"in": "path",
"description": "Slug of assessment to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Assessment"
}
}
}
},
"400": {
"description": "Invalid Assessment"
},
"404": {
"description": "Assessment not found"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/{organization}/tests/{test}/assessments": {
"get": {
"tags": [
"test"
],
"summary": "Find assessments by test",
"description": "Retrieve the assessments under the test",
"operationId": "showAssessments",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "test",
"in": "path",
"description": "id of the test to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Assessment"
}
}
}
}
},
"400": {
"description": "Invalid Test"
},
"404": {
"description": "Test not found"
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"test"
],
"summary": "Create an assessment for an already existing test",
"description": "Returns a single assessment",
"operationId": "store",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "test",
"in": "path",
"description": "id of the test to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"email": {
"description": "Email of the candidate",
"type": "string"
},
"firstname": {
"description": "Firstname of the candidate",
"type": "string"
},
"lastname": {
"description": "Lastname of the candidate",
"type": "string"
},
"notify": {
"description": "Should we notify users for the assessment that will be taken",
"type": "boolean"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Assessment"
}
}
}
},
"400": {
"description": "Invalid Assessment"
},
"404": {
"description": "Assessment not found"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/{organization}/skillareas": {
"get": {
"tags": [
"company-skillarea"
],
"summary": "Get list of all the skillareas in the organization",
"description": "Return a collection of skillareas",
"operationId": "index",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Skillarea collection after a successful request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanySkillarea"
}
}
}
}
},
"400": {
"description": "Bad request"
}
},
"security": [
{
"passport": []
}
]
}
},
"/{organization}/skillareas/{skillarea}": {
"get": {
"tags": [
"company-skillarea"
],
"summary": "Find skillarea by id",
"description": "Returns a single skillarea",
"operationId": "show",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "skillarea",
"in": "path",
"description": "id of the skillarea to return",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanySkillarea"
}
}
}
},
"400": {
"description": "Invalid Skillarea"
},
"404": {
"description": "Skillarea not found"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/skillareas": {
"get": {
"tags": [
"skillarea"
],
"summary": "Get list of all the skillareas in the platform",
"description": "Return a collection of skillareas",
"operationId": "index",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Skillarea collection after a successful request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Skillarea"
}
}
}
}
},
"400": {
"description": "Bad request"
}
},
"security": [
{
"passport": []
}
]
}
},
"/skillareas/{skillarea}": {
"get": {
"tags": [
"skillarea"
],
"summary": "Find skillarea by id",
"description": "Returns a single skillarea",
"operationId": "show",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "skillarea",
"in": "path",
"description": "id of the skillarea to return",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Skillarea"
}
}
}
},
"400": {
"description": "Invalid Skillarea"
},
"404": {
"description": "Skillarea not found"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/{organization}/tests": {
"get": {
"tags": [
"test"
],
"summary": "Get list of all the tests in the organization",
"description": "Return a collection of tests",
"operationId": "index",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Test collection after a successful request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Test"
}
}
}
}
},
"400": {
"description": "Bad request"
}
},
"security": [
{
"passport": []
}
]
},
"post": {
"tags": [
"test"
],
"summary": "Create a test in an organization",
"operationId": "createTest",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"description": "Name of the test",
"type": "string"
},
"password": {
"description": "Password of the test",
"type": "string"
},
"skillareas": {
"description": "Array of skill areas to be included into the assessment",
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Test"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/{organization}/tests/{test}": {
"get": {
"tags": [
"test"
],
"summary": "Find test by id",
"description": "Returns a single test",
"operationId": "show",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "test",
"in": "path",
"description": "id of the test to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Test"
}
}
}
},
"400": {
"description": "Invalid Test"
},
"404": {
"description": "Test not found"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/{organization}/tests/{test}/skillareas": {
"get": {
"tags": [
"test"
],
"summary": "Get skillareas in a test test",
"description": "Retrieve the skillareas under the test",
"operationId": "showSkillareas",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "test",
"in": "path",
"description": "id of the test to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Skillarea"
}
}
}
}
},
"400": {
"description": "Invalid Test"
},
"404": {
"description": "Test not found"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/{organization}/tests/{test}/company-skillareas": {
"get": {
"tags": [
"test"
],
"summary": "Get skillareas in a test test",
"description": "Retrieve the skillareas under the test",
"operationId": "showSkillareas",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "test",
"in": "path",
"description": "id of the test to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanySkillarea"
}
}
}
}
},
"400": {
"description": "Invalid Test"
},
"404": {
"description": "Test not found"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/{organization}/webhooks": {
"get": {
"tags": [
"webhook"
],
"summary": "Get list of all the webhook in the organization",
"description": "Return a collection of webhooks",
"operationId": "index",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Webhooks collection after a successful request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
}
},
"400": {
"description": "Bad request"
}
},
"security": [
{
"passport": []
}
]
},
"post": {
"tags": [
"webhook"
],
"summary": "Create a webhook in an organization",
"operationId": "createWebhook",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"url": {
"description": "Url of the webhook",
"type": "string"
},
"type": {
"description": "Type of the webhook",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/{organization}/webhooks/{webhook}": {
"get": {
"tags": [
"webhook"
],
"summary": "Find webhook by id",
"description": "Returns a single webhook",
"operationId": "show",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhook",
"in": "path",
"description": "Id of the webhook",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"400": {
"description": "Invalid Webhook"
},
"404": {
"description": "Webhook not found"
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"webhook"
],
"summary": "Update a webhook in an organization",
"description": "Update the specified resource in storage.",
"operationId": "updateWebhook",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhook",
"in": "path",
"description": "Id of the webhook",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"url": {
"description": "Url of the webhook",
"type": "string"
},
"type": {
"description": "Type of the webhook",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"delete": {
"tags": [
"webhook"
],
"summary": "Delete a webhook in an organization",
"description": "Remove the specified resource from storage.",
"operationId": "updateWebhook",
"parameters": [
{
"name": "organization",
"in": "path",
"description": "Name of the organization | can be found in the URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "webhook",
"in": "path",
"description": "Id of the webhook",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Webhook not found"
},
"400": {
"description": "Bad reqest"
},
"200": {
"description": "Successful"
}
},
"security": [
{
"api_key": []
}
]
}
}
},
"components": {
"schemas": {
"Assessment": {
"title": "Assessment",
"description": "Assessment that has taken by the candidate. This is linked to the test and the candidate.",
"required": [
"tests_id",
"candidate_id"
],
"properties": {
"guid": {
"schema": "Assessment",
"title": "guid",
"description": "Unique identifier of the assessment",
"type": "string"
},
"created_at": {
"schema": "Assessment",
"title": "created_at",
"description": "Date when the assessment is created",
"type": "string",
"format": "date-time"
},
"updated_at": {
"schema": "Assessment",
"title": "updated_at",
"description": "Date when the assessment is last updated",
"type": "string",
"format": "date-time"
},
"unlocked_at": {
"schema": "Assessment",
"title": "unlocked_at",
"description": "Date when the assessment is unlocked",
"type": "string",
"format": "date-time"
},
"tests_id": {
"schema": "Assessment",
"title": "tests_id",
"description": "Id of the test that the candidate is assessed",
"type": "integer",
"format": "int64"
},
"candidate_id": {
"schema": "Assessment",
"title": "candidate_id",
"description": "Id of candidate that is assessed",
"type": "integer",
"format": "int64"
},
"archived": {
"schema": "Assessment",
"title": "archived",
"description": "Is the assessment is archived",
"type": "boolean"
},
"locked": {
"schema": "Assessment",
"title": "locked",
"description": "Is the assessment is locked",
"type": "boolean"
},
"anonymized": {
"schema": "Assessment",
"title": "anonymized",
"description": "Is the assessment is anonymized",
"type": "boolean"
},
"status": {
"schema": "Assessment",
"title": "status",
"description": "Status of the assessment on progress or completed",
"type": "string"
},
"time": {
"schema": "Assessment",
"title": "time",
"description": "Time in seconds that it took to complete the assessment",
"type": "integer",
"format": "int64"
},
"human_time": {
"schema": "Assessment",
"title": "human_time",
"description": "Human readable time",
"type": "string"
},
"rating": {
"schema": "Assessment",
"title": "rating",
"description": "Rating of the candidate",
"type": "number",
"format": "float"
},
"remark": {
"schema": "Assessment",
"title": "remark",
"description": "Remark of the rating",
"type": "string"
},
"time_limit": {
"schema": "Assessment",
"title": "time_limit",
"description": "Time limit in seconds",
"type": "integer",
"format": "int64"
},
"human_time_limit": {
"schema": "Assessment",
"title": "human_time_limit",
"description": "Time limit in human readable form",
"type": "string"
},
"breaks": {
"schema": "Assessment",
"title": "breaks",
"description": "Breaks that the candidate took during the assessment",
"type": "string"
}
},
"type": "object",
"xml": {
"name": "Assessment"
}
},
"CompanySkillarea": {
"title": "CompanySkillarea",
"description": "Skill areas that are created by the organization for own organization use.",
"required": [],
"properties": {
"id": {
"schema": "CompanySkillarea",
"title": "id",
"description": "Unique identifier of the skillaera",
"type": "integer",
"format": "int64"
},
"name": {
"schema": "CompanySkillarea",
"title": "name",
"description": "Name of the skillarea",
"type": "string"
},
"description": {
"schema": "CompanySkillarea",
"title": "description",
"description": "Description of the skillarea",
"type": "string"
},
"questions": {
"schema": "CompanySkillarea",
"title": "questions",
"description": "Number of questions",
"type": "integer",
"format": "int64"
},
"time_limit": {
"schema": "CompanySkillarea",
"title": "time_limit",
"description": "Time limit on the skillarea",
"type": "integer",
"format": "int64"
}
},
"type": "object",
"xml": {
"name": "CompanySkillarea"
}
},
"Skillarea": {
"title": "Skillarea",
"description": "Skill areas that are created by contributors of kandio.",
"required": [],
"properties": {
"id": {
"schema": "Skillarea",
"title": "id",
"description": "Unique identifier of the skillaera",
"type": "integer",
"format": "int64"
},
"name": {
"schema": "Skillarea",
"title": "name",
"description": "Name of the skillarea",
"type": "string"
},
"description": {
"schema": "Skillarea",
"title": "description",
"description": "Description of the skillarea",
"type": "string"
},
"questions": {
"schema": "Skillarea",
"title": "questions",
"description": "Number of questions",
"type": "integer",
"format": "int64"
},
"time_limit": {
"schema": "Skillarea",
"title": "time_limit",
"description": "Time limit on the skillarea",
"type": "integer",
"format": "int64"
}
},
"type": "object",
"xml": {
"name": "Skillarea"
}
},
"Test": {
"title": "Test",
"description": "Test is the test that is created by the organization that can contain a test for one or more skill area",
"required": [],
"properties": {
"id": {
"schema": "Test",
"title": "id",
"description": "Unique identifier of the skillaera",
"type": "integer",
"format": "int64"
},
"created_at": {
"schema": "Test",
"title": "created_at",
"description": "Date when the test is created",
"type": "string",
"format": "date-time"
},
"ended_at": {
"schema": "Test",
"title": "ended_at",
"description": "Date when the test ends",
"type": "string",
"format": "date-time"
},
"name": {
"schema": "Test",
"title": "name",
"description": "Name of the test",
"type": "string"
},
"archived": {
"schema": "Test",
"title": "archived",
"description": "Is the test archived",
"type": "boolean"
},
"url": {
"schema": "Test",
"title": "url",
"description": "URL where the test can be taken by the candidate",
"type": "string"
},
"time_limit": {
"schema": "Test",
"title": "time_limit",
"description": "Test approximate timelimit in seconds | time limit is the average time the test will have depending on the questions that the candidate will get from the pool",
"type": "string"
},
"password": {
"schema": "Test",
"title": "password",
"description": "Password used to take the test without social login",
"type": "string"
}
},
"type": "object",
"xml": {
"name": "Test"
}
},
"Webhook": {
"title": "Webhook",
"description": "Webhook that has been registered by the organization",
"required": [
"url",
"type"
],
"properties": {
"url": {
"schema": "Webhook",
"title": "url",
"description": "Url of the webhook",
"type": "string"
},
"type": {
"schema": "Webhook",
"title": "type",
"description": "Type of the webhook",
"type": "string"
},
"status": {
"schema": "Webhook",
"title": "status",
"description": "Status of the webhook",
"type": "string"
}
},
"type": "object",
"xml": {
"name": "Assessment"
}
}
},
"securitySchemes": {
"passport": {
"type": "oauth2",
"description": "Laravel passport oauth2 security.",
"in": "header",
"scheme": "https",
"flows": {
"password": {
"authorizationUrl": "https://v2.front.kand.test/oauth/authorize",
"tokenUrl": "https://v2.front.kand.test/oauth/token",
"refreshUrl": "https://v2.front.kand.test/token/refresh",
"scopes": []
}
}
}
}
},
"tags": [
{
"name": "assessment",
"description": ""
},
{
"name": "skillarea",
"description": ""
},
{
"name": "company-skillarea",
"description": ""
},
{
"name": "test",
"description": ""
},
{
"name": "webhook",
"description": ""
}
],
"security": [
[]
]
}