v1

latestOpenAPI 3.0.02026-07-14800227.2 KB

Recruiting

Returns a list of existing candidates.

This endpoint will return a paginated list of candidates. The query params will help to filter the results. Results will include custom fields, if any.

get/recruiting/candidates

Query parameters

_idstring

firstNamestring

lastNamestring

emailstring

sourceFieldstring

privacyPolicyAcceptedboolean

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.

Response

OK. Paginated list of candidates.

Example response

{
  "data": [
    {
      "_id": "674991418c06fbf3f190b165",
      "firstName": "Hans",
      "lastName": "Müller",
      "email": "hans.mueller@example.com",
      "phone": "017612345678",
      "origin": "api",
      "_createdById": "67223a2a77fb00d3fb70cbac",
      "_updatedById": "67223a2a77fb00d3fb70cbac",
      "_createdAt": "2024-11-29T10:02:41.345Z",
      "_updatedAt": "2024-11-29T10:02:41.345Z"
    },
    {
      "_id": "674074c18105acb6617ef8c9",
      "firstName": "Maria",
      "lastName": "Schneider",
      "email": "maria.schneider@example.com",
      "phone": "017698765432",
      "origin": "manually",
      "_createdById": "67223a2a77fb00d3fb70cbac",
      "_updatedById": "67223a2a77fb00d3fb70cbac",
      "_createdAt": "2024-11-22T12:10:41.656Z",
      "_updatedAt": "2024-11-22T12:10:41.656Z"
    },
    {
      "_id": "673f0a2b77a8273b1ded4e1a",
      "firstName": "Klaus",
      "lastName": "Becker",
      "email": "klaus.becker@example.com",
      "phone": "017612345679",
      "origin": "api",
      "_createdById": "6736144449cfd358beefb241",
      "_updatedById": "6736144449cfd358beefb241",
      "_createdAt": "2024-11-21T10:23:39.699Z",
      "_updatedAt": "2024-11-22T12:11:33.532Z"
    }
  ],
  "metadata": {
    "limit": 50,
    "offset": 1,
    "total": 17,
    "count": 17
  }
}