Client Import API

Authentication

Send your API key in the Authorization header.

Authorization: Bearer ppiq_xxxxxxxxxxxxxxxx

Recommended key permissions: upload and read.

Endpoints

Base URL: http://pathpathiq.com

Create requests are asynchronous: submit a job, then poll job status until completed or failed.

• GET /api/client/v1/health
• GET /api/client/v1/openapi
• POST /api/client/v1/import-jobs
• GET /api/client/v1/import-jobs
• GET /api/client/v1/import-jobs/:id
• GET /api/client/v1/import-jobs/:id/errors
• POST /api/client/v1/import-jobs/:id/retry

Machine-Readable Spec

Use the OpenAPI JSON endpoint to generate SDKs and contract tests.

GET http://pathpathiq.com/api/client/v1/openapi

Create Import Job (JSON)

POST /api/client/v1/import-jobs
Idempotency-Key: <unique-request-key>
Content-Type: application/json

{
  "sourceType": "accounts_json",
  "destination": "practice_evolve",
  "accounts": [
    {
      "reference": "ACC-001",
      "accountName": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com",
      "phone": "+353851234567",
      "addressLine1": "123 Main Street",
      "city": "Dublin",
      "eircode": "D01 X1Y2",
      "balance": 1200,
      "placedDate": "2026-02-20"
    }
  ]
}

Create Import Job (Multipart)

POST /api/client/v1/import-jobs
Content-Type: multipart/form-data

file: <your-file>
sourceType: csv | sql_dump (optional)
destination: practice_evolve | paypathiq_db (optional)

Retry Failed Job

POST /api/client/v1/import-jobs/:id/retry

Rate Limits

60 requests per minute per key.

Idempotency behavior: same key + same payload replays existing job (200); same key + different payload returns 409.