Resumes API

Candidates can fetch their full resume using the shortcut /me/resume endpoint, but all updates must go through the main candidate endpoints. When logged in as a candidate and editing the resume, you are required to supply the candidate ID, it is not detected automatically.

Sub-resources of a resume can only be managed using their separate endpoints. For example, although “education” information is included in the full resume payload, you can only make changes to these items via the /candidates/:id/resume/educations endpoints.

Get my resume

This endpoint is only available to candidates

Get the currently logged in candidate’s resume

GET /me/resume

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "street1": "1234 Penny Lane",
  "street2": null,
  "city": "Scranton",
  "state": "Pennsylvania",
  "zip": "18501",
  "coordinates": [
    32.7993,
    -117.16
  ],
  "phone": "8585551212",
  "objective": "Get a job in Scranton, PA",
  "qualifications": "* Stapling\n* Paperclipping\n",
  "published": false,
  "published_at": null,
  "updated_at": "2012-12-09T17:58:26Z",
  "locations": [
    {
      "id": "8a58f89e-d8fe-4477-aeaf-fe37f7c86e8c",
      "distance": 10,
      "city": "San Diego",
      "state": "California",
      "coordinates": [
        32.7993,
        -117.16
      ]
    }
  ],
  "work_experiences": [
    {
      "id": "8d0ec106-2ea1-4905-bcc6-86317085607b",
      "title": "Assistant to the Regional Manager",
      "employer_name": "Dunder Miflin",
      "city": "Scranton",
      "state": "Pennsylvania",
      "start_date": "2010-01-01",
      "end_date": "2012-12-01",
      "duties": "Helping out the world's greatest boss."
    }
  ],
  "educations": [
    {
      "id": "4f87f608-7872-4c37-a845-cbe08d880489",
      "institution": "University of California at Santa Barbara",
      "city": "Santa Barbara",
      "state": "California",
      "degree": "Bachelor of Science",
      "concentration": "Computer Science",
      "start_date": "2002-09-01",
      "end_date": "2006-06-01",
      "graduated": true
    }
  ],
  "awards": [
    {
      "id": "2894c358-f2d0-4a3f-952f-5afdb8dd81aa",
      "description": "Emmy - Best Actor",
      "source": "Academy of Television Arts and Sciences",
      "date": "2012-09-23"
    }
  ],
  "certifications": [
    {
      "id": "aa0438f0-e2fa-4bbc-b932-2be87186c751",
      "description": "Cisco Certified Network Administrator (CCNA)",
      "source": "Cisco",
      "start_date": "2011-01-01",
      "end_date": "2013-12-31"
    }
  ],
  "memberships": [
    {
      "id": "698c9bfb-29d9-4df1-9425-e93c948965d1",
      "description": "American Society for Training and Development (ASTD)",
      "source": "ATSD",
      "start_date": "2011-01-01",
      "end_date": "2013-12-31"
    }
  ],
  "publications": [
    {
      "id": "33dbc578-d2cf-4892-bece-f6e7b5c2c477",
      "description": "Office Relationships at Dunder Miflin",
      "source": "The New York Times",
      "date": "2013-01-01"
    }
  ],
  "trainings": [
    {
      "id": "7c44e640-d3fc-4b07-bc38-3e1c4bdf9d0e",
      "description": "Microsoft Office Specialist",
      "source": "Microsoft",
      "date": "2013-01-01"
    }
  ],
  "languages": [
    {
      "id": "f8c78d5c-f206-41bc-aca3-bd1b4882b4df",
      "name": "Spanish",
      "fluency": "Conversational",
      "read": true,
      "write": false,
      "speak": false
    }
  ],
  "clearances": [
    {
      "id": "f2478635-dec5-4ebf-ada4-454ade6a6d3b",
      "description": "Top Secret",
      "source": "National Security Agency",
      "start_date": "2011-01-01",
      "end_date": "2013-12-31"
    }
  ]
}

Edit a candidate’s resume

This endpoint is only available to candidates and counselors, candidates can only edit their own resume

Update the contact information provided candidate’s resume.

PATCH /candidates/:candidate_id/resume

Input

objective
Optional string
{
  "objective": "Get a job in Scranton, PA"
}

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "street1": "1234 Penny Lane",
  "street2": null,
  "city": "Scranton",
  "state": "Pennsylvania",
  "zip": "18501",
  "coordinates": [
    32.7993,
    -117.16
  ],
  "phone": "8585551212",
  "objective": "Get a job in Scranton, PA",
  "qualifications": "* Stapling\n* Paperclipping\n",
  "published": false,
  "published_at": null,
  "updated_at": "2012-12-09T17:58:26Z",
  "locations": [
    {
      "id": "8a58f89e-d8fe-4477-aeaf-fe37f7c86e8c",
      "distance": 10,
      "city": "San Diego",
      "state": "California",
      "coordinates": [
        32.7993,
        -117.16
      ]
    }
  ],
  "work_experiences": [
    {
      "id": "8d0ec106-2ea1-4905-bcc6-86317085607b",
      "title": "Assistant to the Regional Manager",
      "employer_name": "Dunder Miflin",
      "city": "Scranton",
      "state": "Pennsylvania",
      "start_date": "2010-01-01",
      "end_date": "2012-12-01",
      "duties": "Helping out the world's greatest boss."
    }
  ],
  "educations": [
    {
      "id": "4f87f608-7872-4c37-a845-cbe08d880489",
      "institution": "University of California at Santa Barbara",
      "city": "Santa Barbara",
      "state": "California",
      "degree": "Bachelor of Science",
      "concentration": "Computer Science",
      "start_date": "2002-09-01",
      "end_date": "2006-06-01",
      "graduated": true
    }
  ],
  "awards": [
    {
      "id": "2894c358-f2d0-4a3f-952f-5afdb8dd81aa",
      "description": "Emmy - Best Actor",
      "source": "Academy of Television Arts and Sciences",
      "date": "2012-09-23"
    }
  ],
  "certifications": [
    {
      "id": "aa0438f0-e2fa-4bbc-b932-2be87186c751",
      "description": "Cisco Certified Network Administrator (CCNA)",
      "source": "Cisco",
      "start_date": "2011-01-01",
      "end_date": "2013-12-31"
    }
  ],
  "memberships": [
    {
      "id": "698c9bfb-29d9-4df1-9425-e93c948965d1",
      "description": "American Society for Training and Development (ASTD)",
      "source": "ATSD",
      "start_date": "2011-01-01",
      "end_date": "2013-12-31"
    }
  ],
  "publications": [
    {
      "id": "33dbc578-d2cf-4892-bece-f6e7b5c2c477",
      "description": "Office Relationships at Dunder Miflin",
      "source": "The New York Times",
      "date": "2013-01-01"
    }
  ],
  "trainings": [
    {
      "id": "7c44e640-d3fc-4b07-bc38-3e1c4bdf9d0e",
      "description": "Microsoft Office Specialist",
      "source": "Microsoft",
      "date": "2013-01-01"
    }
  ],
  "languages": [
    {
      "id": "f8c78d5c-f206-41bc-aca3-bd1b4882b4df",
      "name": "Spanish",
      "fluency": "Conversational",
      "read": true,
      "write": false,
      "speak": false
    }
  ],
  "clearances": [
    {
      "id": "f2478635-dec5-4ebf-ada4-454ade6a6d3b",
      "description": "Top Secret",
      "source": "National Security Agency",
      "start_date": "2011-01-01",
      "end_date": "2013-12-31"
    }
  ]
}