--- agentTools: projectIndex: https://kenjo.readme.io/llms.txt --- # Return a list of applications. It will include custom fields, if any. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Kenjo API", "description": "Before starting to use the Kenjo API, you have to request the API activation for a sandbox or production environment to the Kenjo Customer Success team. After that, an admin user has to go to *Settings > Integrations > API keys*, to generate the **API Key**. Follow the steps described in the **Autentication section** of this document.
The API key is needed to request the bearer token. Each endpoint callout requires a valid bearer token in the Authorization header. Once the token is retrieved, it will be useful during the time limit indicated by the 'expiration date'.", "termsOfService": "https://www.kenjo.io/legal/terms-and-conditions", "version": "1.0.0" }, "servers": [ { "url": "https://sandbox-api.kenjo.io/api/v1", "description": "Sandbox environment" }, { "url": "https://api.kenjo.io/api/v1", "description": "Production environment" } ], "tags": [ { "name": "Recruiting", "description": "Operations to manage recruiting processes in Kenjo." } ], "components": { "responses": { "badRequest": { "description": "BAD REQUEST. This is a wrong request in the client side due to invalid body or params.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "number" }, "message": { "type": "string" } }, "example": { "code": 400, "message": "The param 'id' is not valid." } } } } }, "unauthorized": { "description": "UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired." } }, "parameters": { "authorization": { "in": "header", "name": "Authorization", "description": "A valid bearer token.", "schema": { "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ" }, "required": true } } }, "paths": { "/recruiting/applications": { "get": { "summary": "Return a list of applications. It will include custom fields, if any.", "tags": [ "Recruiting" ], "parameters": [ { "in": "header", "$ref": "#/components/parameters/authorization" }, { "name": "_positionId", "in": "query", "schema": { "type": "string" } }, { "name": "_candidateId", "in": "query", "schema": { "type": "string" } }, { "name": "stageId", "in": "query", "schema": { "type": "string" } }, { "name": "isDisqualified", "in": "query", "schema": { "type": "boolean" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "rejectionReason", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Optional filter for pagination proposals. The maximum number of rows to retrieve which determines the size of the page. If this value is not provided then the limit will be 50. The maximum value of the limit is 100 items per page. Only are valid the following limit values: 25, 50 and 100.", "schema": { "type": "number", "enum": [ 25, 50, 100 ], "example": 25 } }, { "name": "offset", "in": "query", "description": "Optional filter for pagination proposals. Determines the number of pages to skip when pagination is being used. If this value is not provided, by default the offset will be 1.", "schema": { "type": "number", "example": 1 } } ], "responses": { "200": { "description": "OK. Paginated list of candidates.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "description": "The unique identifier of the application.", "example": "674991418c06fbf3f190b111" }, "_positionId": { "type": "string", "description": "The id of the position.", "example": "674991418c06fbf3f190b222" }, "_candidateId": { "type": "string", "description": "The id of the candidate who applied to the position.", "example": "674991418c06fbf3f190b333" }, "stageId": { "type": "string", "description": "The id of the stage of this application.", "example": "674991418c06fbf3f190b444" }, "source": { "type": "string", "description": "The source of the entry (e.g., API, manual, agency, browserExtension).", "example": "api" }, "isDisqualified": { "type": "boolean", "description": "If this application has been disqualified or not.", "example": false }, "rejectionReason": { "type": "string", "description": "The reason why the candidate got rejected.", "example": "api" }, "hiredDate": { "type": "string", "format": "date-time", "description": "Timestamp when the candidate was converted to an employee from this application. Set by Kenjo and read-only. Omitted if the candidate was never converted from this application.", "example": "2024-12-01T09:15:00.000Z" }, "rejectionDate": { "type": "string", "format": "date-time", "description": "Timestamp when the application was rejected. Omitted if the application was never rejected.", "example": "2024-12-01T09:15:00.000Z" }, "candidateOrigin": { "type": "string", "description": "The origin of the candidate's application.", "example": "api" }, "_createdById": { "type": "string", "description": "The unique identifier of the creator of the record.", "example": "67223a2a77fb00d3fb70cbac" }, "_updatedById": { "type": "string", "description": "The unique identifier of the updater of the record.", "example": "67223a2a77fb00d3fb70cbac" }, "_createdAt": { "type": "string", "format": "date-time", "description": "The creation date of the record in ISO 8601 format.", "example": "2024-11-29T10:02:41.345Z" }, "_updatedAt": { "type": "string", "format": "date-time", "description": "The last update date of the record in ISO 8601 format.", "example": "2024-11-29T10:02:41.345Z" } } } }, "metadata": { "type": "object", "properties": { "limit": { "type": "number", "description": "The maximum number of items per page.", "example": 50 }, "offset": { "type": "number", "description": "The starting point of the data retrieval.", "example": 1 }, "total": { "type": "number", "description": "The total number of items available.", "example": 17 }, "count": { "type": "number", "description": "The number of items retrieved in the current response.", "example": 17 } } } }, "example": { "data": [ { "_id": "674991418c06fbf3f190b165", "_positionId": "674991418c06fbf3f190b122", "_candidateId": "674991418c06fbf3f190b333", "stageId": "674991418c06fbf3f190b444", "isDisqualified": true, "rejectionReason": "Not enough experience", "source": "api", "_createdById": "6736144449cfd358beefb241", "_updatedById": "6736144449cfd358beefb241", "_createdAt": "2024-11-21T10:23:39.699Z", "_updatedAt": "2024-11-22T12:11:33.532Z" }, { "_id": "674991418c06fbf3f190b166", "_positionId": "674991418c06fbf3f190b124", "_candidateId": "674991418c06fbf3f190b44", "stageId": "674991418c06fbf3f190b444", "isDisqualified": false, "source": "api", "_createdById": "6736144449cfd358beefb241", "_updatedById": "6736144449cfd358beefb241", "_createdAt": "2024-11-21T10:24:39.699Z", "_updatedAt": "2024-11-22T12:14:33.532Z" } ], "metadata": { "limit": 50, "offset": 1, "total": 2, "count": 2 } } } } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 106, "1": 207, "2": 66, "3": 151, "4": 39, "5": 216, "6": 106, "7": 224, "8": 133, "9": 48, "10": 201, "11": 174 } } } ```