List Jobs

# Basic list request
curl -X GET "https://api.docurift.com/v1/jobs" \
-H "X-API-Key: frc_your_api_key_here"

# With filters
curl -X GET "https://api.docurift.com/v1/jobs?status=completed&limit=50&sortBy=createdAt&sortOrder=desc" \
-H "X-API-Key: frc_your_api_key_here"

# Date range filter
curl -X GET "https://api.docurift.com/v1/jobs?startDate=2024-01-01T00:00:00Z&endDate=2024-01-31T23:59:59Z" \
-H "X-API-Key: frc_your_api_key_here"

import requests
import os
from datetime import datetime, timedelta

API_KEY = os.getenv('DOCURIFT_API_KEY')
API_URL = 'https://api.docurift.com/v1'

# Basic list
response = requests.get(
  f'{API_URL}/jobs',
  headers={'X-API-Key': API_KEY}
)

# With filters
params = {
  'status': 'completed',
  'limit': 50,
  'sortBy': 'createdAt',
  'sortOrder': 'desc'
}

response = requests.get(
  f'{API_URL}/jobs',
  headers={'X-API-Key': API_KEY},
  params=params
)

jobs = response.json()
print(f"Total jobs: {jobs['data']['pagination']['total']}")

for job in jobs['data']['jobs']:
  print(f"Job {job['id']}: {job['status']} ({job['progress']}%)")

# Date range filter
end_date = datetime.utcnow()
start_date = end_date - timedelta(days=7)

params = {
  'startDate': start_date.isoformat() + 'Z',
  'endDate': end_date.isoformat() + 'Z'
}

response = requests.get(
  f'{API_URL}/jobs',
  headers={'X-API-Key': API_KEY},
  params=params
)

last_week_jobs = response.json()
print(f"Jobs in last 7 days: {last_week_jobs['data']['pagination']['total']}")

const API_KEY = process.env.DOCURIFT_API_KEY;
const API_URL = 'https://api.docurift.com/v1';

// Basic list
const response = await fetch(`${API_URL}/jobs`, {
headers: {
  'X-API-Key': API_KEY
}
});

const jobs = await response.json();
console.log(`Total jobs: ${jobs.data.pagination.total}`);

// With filters
const params = new URLSearchParams({
status: 'completed',
limit: '50',
sortBy: 'createdAt',
sortOrder: 'desc'
});

const filteredResponse = await fetch(`${API_URL}/jobs?${params}`, {
headers: {
  'X-API-Key': API_KEY
}
});

const filteredJobs = await filteredResponse.json();

for (const job of filteredJobs.data.jobs) {
console.log(`Job ${job.id}: ${job.status} (${job.progress}%)`);
}

// Paginate through all jobs
async function getAllJobs() {
const allJobs = [];
let page = 1;
let hasMore = true;

while (hasMore) {
  const res = await fetch(`${API_URL}/jobs?page=${page}&limit=100`, {
    headers: { 'X-API-Key': API_KEY }
  });

  const data = await res.json();
  allJobs.push(...data.data.jobs);

  hasMore = data.data.pagination.hasNextPage;
  page++;
}

return allJobs;
}

{
"success": true,
"data": {
  "jobs": [
    {
      "id": "job_abc123def456",
      "status": "completed",
      "progress": 100,
      "documentType": "invoice",
      "documentId": "doc_xyz789ghi012",
      "createdAt": "2024-01-27T10:30:00Z",
      "updatedAt": "2024-01-27T10:30:45Z",
      "completedAt": "2024-01-27T10:30:45Z"
    },
    {
      "id": "job_def456ghi789",
      "status": "processing",
      "progress": 67,
      "documentType": "receipt",
      "createdAt": "2024-01-27T10:35:00Z",
      "updatedAt": "2024-01-27T10:35:20Z"
    },
    {
      "id": "job_ghi789jkl012",
      "status": "failed",
      "progress": 15,
      "documentType": "contract",
      "error": {
        "code": "UNSUPPORTED_FORMAT",
        "message": "The document format is not supported"
      },
      "createdAt": "2024-01-27T10:25:00Z",
      "updatedAt": "2024-01-27T10:25:10Z",
      "failedAt": "2024-01-27T10:25:10Z"
    },
    {
      "id": "job_jkl012mno345",
      "status": "pending",
      "progress": 0,
      "documentType": "general",
      "createdAt": "2024-01-27T10:40:00Z",
      "updatedAt": "2024-01-27T10:40:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 156,
    "totalPages": 8,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}
}

{
"success": false,
"error": {
  "code": "INVALID_PARAMETER",
  "message": "Invalid status filter. Must be one of: pending, processing, completed, failed"
}
}

# Get all pending jobs
curl -X GET "https://api.docurift.com/v1/jobs?status=pending" \
-H "X-API-Key: frc_your_api_key_here"

# Get all failed jobs
curl -X GET "https://api.docurift.com/v1/jobs?status=failed" \
-H "X-API-Key: frc_your_api_key_here"

# Get jobs from the last 24 hours
curl -X GET "https://api.docurift.com/v1/jobs?startDate=2024-01-26T10:00:00Z" \
-H "X-API-Key: frc_your_api_key_here"

# Get jobs from a specific week
curl -X GET "https://api.docurift.com/v1/jobs?startDate=2024-01-15T00:00:00Z&endDate=2024-01-21T23:59:59Z" \
-H "X-API-Key: frc_your_api_key_here"

curl -X GET "https://api.docurift.com/v1/jobs?sortBy=updatedAt&sortOrder=desc" \
-H "X-API-Key: frc_your_api_key_here"

# Get completed invoice jobs from the last week, sorted by creation date
curl -X GET "https://api.docurift.com/v1/jobs?status=completed&documentType=invoice&startDate=2024-01-20T00:00:00Z&sortBy=createdAt&sortOrder=desc&limit=50" \
-H "X-API-Key: frc_your_api_key_here"