API Docs
Back to Resume Parsing & Intelligence

Retrieve Parsed Resume

Retrieves the parsed resume by ID.

If parsing is still in progress, the response will include resumeId, status, and data (which will be null).

Once parsing is complete, the full Resume object is returned.

Request Details

path Parameters

FieldTypeRequiredDescription
id
string
YesThe unique identifier of the resume

Sample Request & Response

GET
/v1/resumes/{id}
Sample Request

Headers:

{
  "Authorization": "Bearer <YOUR_API_KEY>"
}

Path Parameters:

{
  "id": "string (required) - The unique identifier of the resume"
}
Sample Response (200)
{
  "id": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "organizationId": "example_string",
  "memberId": "example_string",
  "candidateId": "example_string",
  "locationId": "example_string",
  "url": "example_string",
  "name": "example_string",
  "rawText": "example_string",
  "mimetype": "example_string",
  "personalInfo": {
    "name": "example_string",
    "occupation": "example_string",
    "email": "example_string",
    "phone": "example_string",
    "url": "example_string",
    "summary": "example_string",
    "location": {},
    "profiles": []
  },
  "work": [
    {
      "__id": "example_string",
      "company": "example_string",
      "position": "example_string",
      "location": "example_string",
      "url": "example_string",
      "startDate": "example_string",
      "endDate": "example_string",
      "summary": "example_string",
      "highlights": [
        {
          "__id": "example_string",
          "value": "example_string"
        }
      ]
    }
  ],
  "volunteer": [
    {
      "__id": "example_string",
      "organization": "example_string",
      "position": "example_string",
      "startDate": "example_string",
      "endDate": "example_string",
      "summary": "example_string",
      "highlights": [
        {
          "__id": "example_string",
          "value": "example_string"
        }
      ]
    }
  ],
  "education": [
    {
      "__id": "example_string",
      "institution": "example_string",
      "area": "example_string",
      "studyType": "example_string",
      "startDate": "example_string",
      "endDate": "example_string",
      "score": "example_string",
      "summary": "example_string",
      "courses": []
    }
  ],
  "projects": [
    {
      "__id": "example_string",
      "name": "example_string",
      "startDate": "example_string",
      "endDate": "example_string",
      "description": "example_string",
      "highlights": [],
      "url": "example_string"
    }
  ],
  "skills": [
    {
      "__id": "example_string",
      "name": "example_string",
      "level": "example_string",
      "keywords": []
    }
  ],
  "languages": [
    {
      "__id": "example_string",
      "language": "example_string",
      "fluency": "example_string"
    }
  ],
  "interests": [
    {
      "__id": "example_string",
      "name": "example_string",
      "keywords": []
    }
  ],
  "references": [
    {
      "__id": "example_string",
      "name": "example_string",
      "position": "example_string",
      "company": "example_string",
      "email": "example_string",
      "phone": "example_string",
      "relationship": "example_string"
    }
  ],
  "certificates": [
    {
      "__id": "example_string",
      "name": "example_string",
      "date": "example_string",
      "issuer": "example_string",
      "url": "example_string"
    }
  ],
  "publications": [
    {
      "__id": "example_string",
      "name": "example_string",
      "publisher": "example_string",
      "releaseDate": "example_string",
      "url": "example_string",
      "summary": "example_string"
    }
  ],
  "awards": [
    {
      "__id": "example_string",
      "title": "example_string",
      "date": "example_string",
      "awarder": "example_string",
      "summary": "example_string"
    }
  ]
}