Partner API

QuickTrade Open API

Integrate QuickTrade job listings and verified worker profiles into your platform. Contact us to obtain a partner API key.

REST API
JSON responses
API key authentication

Authentication

All partner API endpoints require an x-api-key header. Contact support@quicktrade.co.nz to obtain a key.

# Include in every request:
x-api-key: your_api_key_here

Base URL

https://quicktrade-pi.vercel.app

Endpoints

GET/api/partner/jobs

Returns a paginated list of open job listings. Jobs are ordered by creation date, newest first.

Parameters

pageintegerPage number (default: 1)
pageSizeintegerResults per page, max 100 (default: 20)

Example Request

curl -X GET "https://quicktrade-pi.vercel.app/api/partner/jobs?page=1&pageSize=10" \
  -H "x-api-key: your_api_key_here"

Example Response

{
  "jobs": [
    {
      "id": "abc123",
      "title": "Bathroom Renovation — Plumbing",
      "description": "Need a licensed plumber for a full bathroom remodel...",
      "category": "plumbing",
      "location": "Auckland",
      "budget": 2500,
      "budgetType": "fixed",
      "urgency": "medium",
      "createdAt": "2025-01-15T08:30:00.000Z",
      "country": "NZ"
    }
  ],
  "total": 42,
  "page": 1,
  "pageSize": 10
}
GET/api/partner/workers

Returns a paginated list of verified worker profiles. Includes availability, skills, and ratings.

Parameters

pageintegerPage number (default: 1)
pageSizeintegerResults per page, max 100 (default: 20)

Example Request

curl -X GET "https://quicktrade-pi.vercel.app/api/partner/workers?page=1&pageSize=10" \
  -H "x-api-key: your_api_key_here"

Example Response

{
  "workers": [
    {
      "uid": "worker_uid_here",
      "displayName": "James Wilson",
      "location": "Wellington",
      "skills": ["Plumbing", "Gas Fitting", "Drainage"],
      "hourlyRate": 95,
      "rating": 4.9,
      "reviewCount": 38,
      "completedJobs": 45,
      "availability": "available",
      "country": "NZ"
    }
  ],
  "total": 87,
  "page": 1,
  "pageSize": 10
}

Error Codes

200OKRequest succeeded.
400Bad RequestInvalid parameters.
401UnauthorisedMissing or invalid API key.
500Internal Server ErrorSomething went wrong on our end.

Rate Limits & Fair Use

Partner API keys are subject to fair use policies. Contact support@quicktrade.co.nz if you need higher limits or a dedicated integration agreement.