User

Developer API Reference

Build powerful integrations with our platform APIs.

← Back to Dashboard

Manage API Keys

Jobs

Dynamic API reference synchronized with our latest backend endpoints.

POST

Add candidate to job

/api/v1/jobs/{id}/applicants

Links an existing candidate to a job requirement. Updates the candidate's job_id.

Parameters

idRequiredstring

The Job UUID

candidate_idRequiredstring

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/jobs/{id}/applicants" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"candidate_id":"123e4567-e89b-12d3-a456-426614174000"}'

Example Response

json

{
  "success": true,
  "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
  "job_id": "job-123e4567-e89b-12d3-a456-426614174000"
}

GET

Get job details

/api/v1/jobs/{id}

Returns the details of a specific job requirement.

Parameters

idRequiredstring

The job UUID

Example Request

bash

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

Example Response

json

{
  "id": "job-123e4567-e89b-12d3-a456-426614174000",
  "title": "Senior Frontend Engineer",
  "description": "Expert in React/Next.js",
  "department": "Engineering",
  "status": "active",
  "created_at": "2026-02-25T08:00:00Z"
}

PUT

Update job details

/api/v1/jobs/{id}

Updates an existing job requirement.

Parameters

idRequiredstring

The job UUID

titlestring

descriptionstring

departmentstring

statusstring

Example Request

bash

curl -X PUT "https://your-tenant.peoplelensai.com/api/v1/jobs/{id}" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","department":"string","status":"active"}'

Example Response

json

{
  "id": "job-123e4567-e89b-12d3-a456-426614174000",
  "title": "Senior Frontend Engineer",
  "description": "Expert in React/Next.js",
  "department": "Engineering",
  "status": "active",
  "created_at": "2026-02-25T08:00:00Z"
}

POST

Bulk sync jobs

/api/v1/jobs/bulk

Creates or updates multiple jobs in a single request. Atomic operation. Max 50 items. Use this to keep your job catalog in sync with an external ATS.

Parameters

jobsRequiredarray

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/jobs/bulk" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"jobs":[{"id":"123e4567-e89b-12d3-a456-426614174000","title":"string","description":"string","department":"string","status":"active","external_id":"string"}]}'

Example Response

json

{
  "synced": 2,
  "data": [
    {
      "id": "job-123e4567-e89b-12d3-a456-426614174000",
      "title": "Senior Frontend Engineer",
      "description": "Expert in React/Next.js",
      "department": "Engineering",
      "status": "active"
    }
  ]
}

GET

List active jobs

/api/v1/jobs

Returns a list of active job requirements for the authenticated tenant.

Parameters

external_idstring

Filter by ID from external system

Example Request

bash

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

Example Response

json

[
  {
    "id": "job-123e4567-e89b-12d3-a456-426614174000",
    "title": "Senior Frontend Engineer",
    "description": "We are looking for an expert in Next.js and React...",
    "department": "Engineering",
    "status": "active",
    "external_id": "ext_job_99",
    "metadata": {
      "source": "greenhouse",
      "priority": "high"
    },
    "created_at": "2026-02-25T08:00:00Z"
  }
]

POST

Create or sync a job

/api/v1/jobs

Creates a new job requirement in the system. Subject to plan limitations.

Parameters

titleRequiredstring

descriptionRequiredstring

departmentstring

company_card_idstring

external_idstring

metadataobject

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/jobs" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","department":"string","company_card_id":"123e4567-e89b-12d3-a456-426614174000","external_id":"string","metadata":{}}'

Example Response

json

{
  "id": "job-123e4567-e89b-12d3-a456-426614174000",
  "title": "Senior Frontend Engineer",
  "description": "Expert in React/Next.js",
  "department": "Engineering",
  "status": "active",
  "external_id": "ext_job_99",
  "metadata": {
    "source": "greenhouse"
  },
  "created_at": "2026-02-25T08:00:00Z"
}

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

Jobs

Dynamic API reference synchronized with our latest backend endpoints.

POST

Add candidate to job

/api/v1/jobs/{id}/applicants

Links an existing candidate to a job requirement. Updates the candidate's job_id.

Parameters

idRequiredstring

The Job UUID

candidate_idRequiredstring

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/jobs/{id}/applicants" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"candidate_id":"123e4567-e89b-12d3-a456-426614174000"}'

Example Response

json

{
  "success": true,
  "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
  "job_id": "job-123e4567-e89b-12d3-a456-426614174000"
}

GET

Get job details

/api/v1/jobs/{id}

Returns the details of a specific job requirement.

Parameters

idRequiredstring

The job UUID

Example Request

bash

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

Example Response

json

{
  "id": "job-123e4567-e89b-12d3-a456-426614174000",
  "title": "Senior Frontend Engineer",
  "description": "Expert in React/Next.js",
  "department": "Engineering",
  "status": "active",
  "created_at": "2026-02-25T08:00:00Z"
}

PUT

Update job details

/api/v1/jobs/{id}

Updates an existing job requirement.

Parameters

idRequiredstring

The job UUID

titlestring

descriptionstring

departmentstring

statusstring

Example Request

bash

curl -X PUT "https://your-tenant.peoplelensai.com/api/v1/jobs/{id}" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","department":"string","status":"active"}'

Example Response

json

{
  "id": "job-123e4567-e89b-12d3-a456-426614174000",
  "title": "Senior Frontend Engineer",
  "description": "Expert in React/Next.js",
  "department": "Engineering",
  "status": "active",
  "created_at": "2026-02-25T08:00:00Z"
}

POST

Bulk sync jobs

/api/v1/jobs/bulk

Creates or updates multiple jobs in a single request. Atomic operation. Max 50 items. Use this to keep your job catalog in sync with an external ATS.

Parameters

jobsRequiredarray

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/jobs/bulk" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"jobs":[{"id":"123e4567-e89b-12d3-a456-426614174000","title":"string","description":"string","department":"string","status":"active","external_id":"string"}]}'

Example Response

json

{
  "synced": 2,
  "data": [
    {
      "id": "job-123e4567-e89b-12d3-a456-426614174000",
      "title": "Senior Frontend Engineer",
      "description": "Expert in React/Next.js",
      "department": "Engineering",
      "status": "active"
    }
  ]
}

GET

List active jobs

/api/v1/jobs

Returns a list of active job requirements for the authenticated tenant.

Parameters

external_idstring

Filter by ID from external system

Example Request

bash

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

Example Response

json

[
  {
    "id": "job-123e4567-e89b-12d3-a456-426614174000",
    "title": "Senior Frontend Engineer",
    "description": "We are looking for an expert in Next.js and React...",
    "department": "Engineering",
    "status": "active",
    "external_id": "ext_job_99",
    "metadata": {
      "source": "greenhouse",
      "priority": "high"
    },
    "created_at": "2026-02-25T08:00:00Z"
  }
]

POST

Create or sync a job

/api/v1/jobs

Creates a new job requirement in the system. Subject to plan limitations.

Parameters

titleRequiredstring

descriptionRequiredstring

departmentstring

company_card_idstring

external_idstring

metadataobject

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/jobs" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","department":"string","company_card_id":"123e4567-e89b-12d3-a456-426614174000","external_id":"string","metadata":{}}'

Example Response

json

{
  "id": "job-123e4567-e89b-12d3-a456-426614174000",
  "title": "Senior Frontend Engineer",
  "description": "Expert in React/Next.js",
  "department": "Engineering",
  "status": "active",
  "external_id": "ext_job_99",
  "metadata": {
    "source": "greenhouse"
  },
  "created_at": "2026-02-25T08:00:00Z"
}