Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate

candidate.search

Searches for candidates by email and/or name.

Requires the candidatesRead permission.

post/candidate.search

Request body

emailstring nullable

The candidate's email

namestring nullable

The candidate's name

Response

Responses from the candidate.search endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-16T10:30:00.000Z",
      "name": "Adam Hart",
      "primaryEmailAddress": {
        "value": "adam.hart@example.com",
        "type": "Personal",
        "isPrimary": true
      },
      "emailAddresses": [
        {
          "value": "adam.hart@example.com",
          "type": "Personal",
          "isPrimary": true
        }
      ],
      "primaryPhoneNumber": null,
      "phoneNumbers": [],
      "socialLinks": [],
      "tags": [],
      "applicationIds": [
        "f9e52a51-a075-4116-a7b8-484deba69004"
      ],
      "resumeFileHandle": null,
      "fileHandles": [],
      "profileUrl": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "source": null,
      "creditedToUser": null,
      "timezone": null,
      "fraudStatus": null
    }
  ]
}