User

Developer API Reference

Build powerful integrations with our platform APIs.

← Back to Dashboard

Manage API Keys

Candidates

Dynamic API reference synchronized with our latest backend endpoints.

GET

Retrieve Parsed Resume Data

/api/v1/candidates/{id}/documents/parsed

Fetch the structured data extracted from a candidate's uploaded resume (skills, experience history, education).

Parameters

idRequiredstring

The Candidate ID

Example Request

bash

curl -X GET "https://your-tenant.peoplelensai.com/api/v1/candidates/{id}/documents/parsed" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Example Response

json

{
  "id": "c845b4c1-4b13-432d-949d-3f5f30b9123b",
  "professional_summary": "Senior Frontend Engineer with 8 years of experience.",
  "core_skills": "React, TypeScript, Next.js, Node.js",
  "experience_summary": "Tech Lead at Acme Corp (2020-2024).",
  "education_summary": "BSc Computer Science, MIT",
  "certifications": "AWS Certified Developer",
  "languages": [
    "English",
    "Spanish"
  ],
  "projects_achievements": "Led migration to Next.js App Router"
}

POST

Bulk create candidates

/api/v1/candidates/bulk

Creates multiple candidates in a single request. Subject to plan limitations. Fails atomically if quota is exceeded.

Parameters

candidatesRequiredarray

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/candidates/bulk" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"candidates":[{"first_name":"string","last_name":"string","email":"string","phone":"string","linkedin_url":"string","job_id":"string"}]}'

Example Response

json

{
  "created": 2,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "status": "active"
    }
  ]
}

GET

List candidates

/api/v1/candidates

Returns a paginated list of candidates for the authenticated tenant. Supports filtering by status and job_id.

Parameters

statusstring

Filter candidates by status

job_idstring

Filter candidates assigned to a specific job

limitinteger

Max results to return (max 200)

external_idstring

Filter by external system ID

offsetinteger

Offset for pagination

Example Request

bash

curl -X GET "https://your-tenant.peoplelensai.com/api/v1/candidates" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Example Response

json

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "status": "active",
      "external_id": "gh_8877",
      "metadata": {
        "ats": "greenhouse"
      }
    }
  ],
  "pagination": {
    "total": 124,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

POST

Create a new candidate

/api/v1/candidates

Injects a candidate directly into the ATS database. Requires an active API Key. Subject to plan limitations and active billing quotas.

Parameters

first_nameRequiredstring

last_nameRequiredstring

emailstring

phonestring

linkedin_urlstring

job_idstring

The UUID of the job requirement they are applying for.

external_idstring

ID from an external system (e.g., ATS).

metadataobject

Flexible JSON object for custom integration data.

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/candidates" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"string","last_name":"string","email":"string","phone":"string","linkedin_url":"string","job_id":"string","external_id":"string","metadata":{}}'

Example Response

json

{
  "id": "can-123e4567-e89b-12d3-a456-426614174000",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "status": "active",
  "external_id": "gh_8877",
  "metadata": {
    "ats": "greenhouse"
  }
}

Fetching data...

📊 Analytics

User

⚙️ Settings

Developer API Reference

Build powerful integrations with our platform APIs.

← Back to Dashboard

Developer API Reference

Build powerful integrations with our platform APIs.

← Back to Dashboard

Manage API Keys

Candidates

Dynamic API reference synchronized with our latest backend endpoints.

GET

Retrieve Parsed Resume Data

/api/v1/candidates/{id}/documents/parsed

Fetch the structured data extracted from a candidate's uploaded resume (skills, experience history, education).

Parameters

idRequiredstring

The Candidate ID

Example Request

bash

curl -X GET "https://your-tenant.peoplelensai.com/api/v1/candidates/{id}/documents/parsed" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Example Response

json

{
  "id": "c845b4c1-4b13-432d-949d-3f5f30b9123b",
  "professional_summary": "Senior Frontend Engineer with 8 years of experience.",
  "core_skills": "React, TypeScript, Next.js, Node.js",
  "experience_summary": "Tech Lead at Acme Corp (2020-2024).",
  "education_summary": "BSc Computer Science, MIT",
  "certifications": "AWS Certified Developer",
  "languages": [
    "English",
    "Spanish"
  ],
  "projects_achievements": "Led migration to Next.js App Router"
}

POST

Bulk create candidates

/api/v1/candidates/bulk

Creates multiple candidates in a single request. Subject to plan limitations. Fails atomically if quota is exceeded.

Parameters

candidatesRequiredarray

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/candidates/bulk" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"candidates":[{"first_name":"string","last_name":"string","email":"string","phone":"string","linkedin_url":"string","job_id":"string"}]}'

Example Response

json

{
  "created": 2,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "status": "active"
    }
  ]
}

GET

List candidates

/api/v1/candidates

Returns a paginated list of candidates for the authenticated tenant. Supports filtering by status and job_id.

Parameters

statusstring

Filter candidates by status

job_idstring

Filter candidates assigned to a specific job

limitinteger

Max results to return (max 200)

external_idstring

Filter by external system ID

offsetinteger

Offset for pagination

Example Request

bash

curl -X GET "https://your-tenant.peoplelensai.com/api/v1/candidates" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Example Response

json

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "status": "active",
      "external_id": "gh_8877",
      "metadata": {
        "ats": "greenhouse"
      }
    }
  ],
  "pagination": {
    "total": 124,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

POST

Create a new candidate

/api/v1/candidates

Injects a candidate directly into the ATS database. Requires an active API Key. Subject to plan limitations and active billing quotas.

Parameters

first_nameRequiredstring

last_nameRequiredstring

emailstring

phonestring

linkedin_urlstring

job_idstring

The UUID of the job requirement they are applying for.

external_idstring

ID from an external system (e.g., ATS).

metadataobject

Flexible JSON object for custom integration data.

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/candidates" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"string","last_name":"string","email":"string","phone":"string","linkedin_url":"string","job_id":"string","external_id":"string","metadata":{}}'

Example Response

json

{
  "id": "can-123e4567-e89b-12d3-a456-426614174000",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "status": "active",
  "external_id": "gh_8877",
  "metadata": {
    "ats": "greenhouse"
  }
}