Skip to main content
Quick Test Tips
  1. Start without filters to see all recent jobs
  2. Use status filter to find jobs in a specific state
  3. Combine created_after and created_before for date ranges
  4. Adjust limit (1-100) to control page size
The default limit is 25. Increase it to fetch more jobs per request.
GET
/
v1
/
jobs
List jobs
curl --request GET \
  --url https://api.peepal.dev/v1/jobs \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "status": "created",
      "progress": 50,
      "template_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "person": {
        "full_name": "<string>",
        "aliases": [
          "<string>"
        ],
        "location": "<string>",
        "email": "[email protected]",
        "email_domain": "<string>",
        "linkedin_url": "<string>",
        "github_url": "<string>",
        "personal_website": "<string>",
        "current_company": "<string>",
        "current_title": "<string>",
        "education_seed": [
          {
            "school": "<string>",
            "degree": "<string>",
            "field": "<string>",
            "start_year": 123,
            "end_year": 123
          }
        ],
        "employment_seed": [
          {
            "employer": "<string>",
            "title": "<string>",
            "start_date": "<string>",
            "end_date": "<string>"
          }
        ]
      },
      "claims": [
        {
          "claim_key": "<string>",
          "claim_type": "<unknown>",
          "expected": {
            "school": "<string>",
            "degree": "<string>",
            "field": "<string>",
            "start_year": 123,
            "end_year": 123
          },
          "match_rules": {
            "match_strength": "strict",
            "min_confidence": 0.5
          },
          "weight": 5
        }
      ],
      "options": {
        "depth": "light",
        "max_sources": 30,
        "max_cost_usd": 1,
        "exa_category": "auto",
        "allow_domains": [
          "<string>"
        ],
        "deny_domains": [
          "<string>"
        ],
        "webhook": {
          "endpoint_id": "<string>",
          "events": [
            "job.created"
          ]
        }
      },
      "metadata": {},
      "links": {
        "self": "<string>",
        "report": "<string>",
        "sources": "<string>"
      }
    }
  ],
  "next_cursor": "<string>"
}
Retrieve a paginated list of jobs for your project, with optional filtering by status and date range.

​
Pagination

This endpoint uses cursor-based pagination. Use the next_cursor from the response to fetch the next page. 
curl -X GET "https://api.peepal.dev/v1/jobs?limit=25&status=completed" \
  -H "x-api-key: YOUR_API_KEY"

{
  "data": [
    {
      "id": "job_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "status": "completed",
      "progress": 100,
      "template_id": null,
      "created_at": "2025-12-31T10:00:00Z",
      "started_at": "2025-12-31T10:00:05Z",
      "completed_at": "2025-12-31T10:02:30Z",
      "error": null,
      "person": {
        "full_name": "Ada Lovelace"
      },
      "claims": [],
      "links": {
        "self": "https://api.peepal.dev/v1/jobs/job_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "report": "https://api.peepal.dev/v1/jobs/job_01ARZ3NDEKTSV4RRFFQ69G5FAV/report",
        "sources": "https://api.peepal.dev/v1/jobs/job_01ARZ3NDEKTSV4RRFFQ69G5FAV/sources"
      }
    }
  ],
  "next_cursor": "job_01ARZ3NDEKTSV4RRFFQ69G5FAZ"
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer
default:25
Required range: 1 <= x <= 100
​
cursor
string
​
status
enum<string>
Available options:
created,
queued,
running,
completed,
failed,
canceled
​
created_after
string<date-time>
​
created_before
string<date-time>

Response

Paginated list of jobs

​
data
object[]
required
​
next_cursor
string | null
required