v1

latestOpenAPI 3.0.02026-07-14800227.2 KB

Recruiting

Return a list of applications. It will include custom fields, if any.

get/recruiting/applications

Query parameters

_positionIdstring

_candidateIdstring

stageIdstring

isDisqualifiedboolean

sourcestring

rejectionReasonstring

limit25 | 50 | 100

Example:25

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.

offsetnumber

Example:1

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.

Headers

Authorizationstring required

Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

OK. Paginated list of candidates.

Example response

{
  "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
  }
}