Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Job

job.search

Searches jobs by title or custom requisition id. At least one of title or requisitionId must be provided.

Requires the jobsRead permission.

post/job.search

Request body

titlestring nullable

The title (or substring of a title) of the job to search for

requisitionIdstring nullable

The custom requisition id (or substring) of the job to search for

Example request

{
  "title": "Software Engineer",
  "requisitionId": "REQ-2471"
}

Response

Responses from the job.search endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "1be42b8e-cafd-4beb-8121-f4981eb20f42",
      "title": "Software Engineer",
      "confidential": false,
      "status": "Open",
      "employmentType": "FullTime",
      "locationId": "3ae2b801-19f6-41ef-ad28-214bd731948f",
      "departmentId": "f9e52a51-a075-4116-a7b8-484deba69004",
      "defaultInterviewPlanId": "595ae947-e308-4a36-af06-70b7f6e0fb82",
      "interviewPlanIds": [
        "595ae947-e308-4a36-af06-70b7f6e0fb82"
      ],
      "jobPostingIds": [],
      "customRequisitionId": "ENG-01",
      "brandId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "hiringTeam": [],
      "customFields": [],
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "openedAt": "2024-01-02T00:00:00.000Z",
      "closedAt": null
    }
  ]
}