Fetch Job Seeker

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Including Structured Section Responses

If you want to include structured section responses in your request, ensure your params include the following: include=structured_section_responses.answers


Parsed CV data (work and education history)

When a candidate's CV is parsed, Pinpoint stores one record per role in their work history and one per qualification. You can read these records alongside the job seeker by including the resume and its histories:

include=resume.employment_histories,resume.education_histories
  • No extra API key scope is needed. Any key that can read the job seeker can read the parsed CV data.
  • These records are read-only, and you can only reach them through this include. There is no separate endpoint for them.
  • start_date and end_date are strings copied from the CV (for example 2011-01, 2009 or current). They are not always valid dates, so don't parse them as dates without checking.
  • If no CV was parsed, relationships.resume.data is null and the response has no CV records under included.
Example response
{
  "data": {
    "id": "1",
    "type": "job_seekers",
    "attributes": { "...": "..." },
    "relationships": {
      "resume": {
        "data": { "type": "resumes", "id": "21" }
      }
    }
  },
  "included": [
    {
      "id": "21",
      "type": "resumes",
      "attributes": {
        "created_at": "2026-06-29T16:07:50+00:00",
        "updated_at": "2026-06-29T16:07:50+00:00"
      },
      "relationships": {
        "employment_histories": {
          "data": [{ "type": "employment_histories", "id": "161" }]
        },
        "education_histories": {
          "data": [{ "type": "education_histories", "id": "1" }]
        }
      }
    },
    {
      "id": "161",
      "type": "employment_histories",
      "attributes": {
        "employer_name": "Acme Corporation",
        "organisation_name": "Acme Corporation",
        "title": "Head of Engineering",
        "description": "Led the payments team and moved billing onto a new platform.",
        "current": true,
        "start_date": "2019-03",
        "end_date": "current",
        "country_code": "GB",
        "region": "England",
        "municipality": "London",
        "job_level": "Executive (VP, Dept Head)",
        "skills_category": null,
        "skills_comments": null,
        "created_at": "2026-06-29T16:07:50+00:00",
        "updated_at": "2026-06-29T16:07:50+00:00"
      }
    },
    {
      "id": "1",
      "type": "education_histories",
      "attributes": {
        "school_name": "University of Manchester",
        "start_date": "2012",
        "end_date": "2015",
        "city": "Manchester",
        "state": null,
        "country": "United Kingdom",
        "comments": "University of Manchester\nBSc Computer Science, 2012 - 2015",
        "created_at": "2026-06-29T16:07:50+00:00",
        "updated_at": "2026-06-29T16:07:50+00:00"
      }
    }
  ]
}
Path Params
string
required

ID of the resource

Query Params
extra_fields[job_seekers]
array of objects, unique

Include fields that are not always needed, or perhaps computationally expensive

include
array of strings, unique
fields[job_seekers]
array of objects, unique
fields[answers]
array of objects, unique
fields[candidates]
array of objects, unique
fields[comments]
array of objects, unique
fields[custom_attributes]
array of objects, unique
fields[structured_section_responses]
array of objects, unique
fields[user_scorecards]
array of objects, unique
fields[resumes]
array of objects, unique
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json