Skip to Content
Resume tools

Parse a resume into structured fields

POST
/developer/parse

Parses resume text into structured fields: contact, work history, education, skills and suggested titles. Spends the tokens it uses plus the request fee, recorded as parse.

Authorization

DeveloperKey
headerAuthorizationBearer <gm_live_...>

A GetMattered developer API key, sent as Authorization: Bearer gm_live_....

Request Body

application/json
  1. body
resumeText*string

The resume as plain text or Markdown, 50 to 50,000 characters.

Length50 <= length <= 50000

Response Body

The structured resume.

application/json
  1. response

Successful API response

data*
meta?
success*true
Value intrue
Example Request
curl -X POST 'https://api.getmattered.com/api/v1/developer/parse' \
  -H 'Content-Type: application/json' \
  -d '{
  "resumeText": "stringstringstringstringstringstringstringstringst"
}'
Example Response
{
  "data": {
    "addressLine1": "string",
    "city": "string",
    "companySize": [
      "string"
    ],
    "country": "string",
    "currentJobTitle": "string",
    "education": [
      {
        "degree": "string",
        "institution": "string",
        "year": "string"
      }
    ],
    "educationLevel": "string",
    "email": "string",
    "experienceLevel": "string",
    "fieldEvidence": [
      {
        "confidence": "high",
        "field": "addressLine1",
        "quote": "string"
      }
    ],
    "firstName": "string",
    "fullName": "string",
    "githubUrl": "string",
    "industries": [
      "string"
    ],
    "jobTypes": [
      "string"
    ],
    "lastName": "string",
    "linkedinUrl": "string",
    "phone": "string",
    "portfolioUrl": "string",
    "prefill": {
      "addressLine1": "string",
      "city": "string",
      "country": "string",
      "currentEmployer": "string",
      "githubUrl": "string",
      "highestEducation": "high_school",
      "homeLocation": "string",
      "linkedinUrl": "string",
      "ownTitles": [
        "string"
      ],
      "phone": "string",
      "portfolioUrl": "string",
      "seeded": {
        "jobPreferences": {
          "locations": true,
          "experienceLevels": true,
          "skills": true,
          "targetRoles": true
        },
        "profile": {
          "addressLine1": true,
          "city": true,
          "state": true,
          "country": true,
          "zipCode": true,
          "phone": true,
          "linkedinUrl": true,
          "githubUrl": true,
          "portfolioUrl": true,
          "currentEmployer": true,
          "highestEducation": true,
          "yearsOfExperience": true
        }
      },
      "state": "string",
      "workHistoryLocations": [
        "string"
      ],
      "yearsOfExperience": 0,
      "zipCode": "string"
    },
    "professionalSummary": "string",
    "skills": [
      "string"
    ],
    "state": "string",
    "suggestedJobTitles": [
      "string"
    ],
    "suggestedLocations": [
      "string"
    ],
    "workExperience": [
      {
        "company": "string",
        "current": true,
        "description": "string",
        "endDate": "string",
        "location": "string",
        "startDate": "string",
        "title": "string"
      }
    ],
    "yearsOfExperience": 0,
    "zipCode": "string",
    "usage": {
      "tokens": 0
    }
  },
  "meta": {
    "duration": 0,
    "performance": {
      "dbQueries": 0,
      "totalDbTime": 0
    },
    "requestId": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "version": "string"
  },
  "success": true
}