Scout SelectDeveloper Documentation
Assessments

Candidates

Search existing candidates or create a new one.

Search candidates

Requires SEARCH_CANDIDATES. Paginated; field narrows which column is matched against search.

query DeveloperCandidates($search: String, $field: DeveloperCandidateSearchField, $page: Int, $limit: Int) {
  developerCandidates(search: $search, field: $field, page: $page, limit: $limit) {
    data {
      id
      handle
      name
      email
      phone
      resumeUrl
      createdAt
    }
    total
    page
    limit
  }
}

field accepts ANY (default, matches name or email), NAME, or EMAIL. page defaults to 1, limit defaults to 20.

Create a candidate

Requires CREATE_CANDIDATE.

mutation CreateCandidate($input: DeveloperCreateCandidateInput!) {
  developerCreateCandidate(input: $input) {
    id
    handle
    name
    email
    phone
    resumeUrl
    createdAt
  }
}
Variables
{
  "input": {
    "name": "Jane Doe",
    "email": "jane@example.com",
    "phone": "+65 9123 4567",
    "resumeUrl": "https://example.com/resumes/jane-doe.pdf"
  }
}

name and email are required. A candidate email must be unique within your organisation - creating a duplicate returns a CONFLICT error rather than a second record, so search first if you're not sure the candidate already exists.

On this page