Proxiant API

Quickstart

Get up and running in three steps. You'll have live data in under two minutes.

curl https://api.proxiant.co/v1/jobs \
  -H "Authorization: Bearer prx_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "job_number": "FH-2025-04812",
      "status": "in_progress",
      "recipient_name": "James R. Thornton"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 243
  }
}

Base URL & Versioning

All API requests use this base URL:

https://api.proxiant.co/v1

The current version is v1. We follow a conservative versioning policy:

• Breaking changes — increment the version (v1 → v2). You get advance notice and a migration guide.
• Non-breaking additions — new fields, new endpoints, new event types — are added without a version bump.

Authentication

The Proxiant API uses bearer token authentication. Include your API key in the Authorization header of every request. Keys are firm-scoped — a key can only access data belonging to the firm it was created for.

Authorization: Bearer prx_live_xxxxxxxxxxxxxxxxxxxx

Keys use the prefix prx_live_ for production. Sandbox keys (fh_test_) are coming soon. See the Authentication reference for full details on key management, permission scopes, and security best practices.

Request Format

A few conventions apply to all requests and responses:

Pagination

All list endpoints are paginated. Use page and per_page query parameters to navigate through results. The default page size is 50; the maximum is 100.

# Fetch page 3, 25 results per page
curl "https://api.proxiant.co/v1/jobs?page=3&per_page=25" \
  -H "Authorization: Bearer prx_live_xxxxxxxxxxxx"

Every paginated response includes a meta object:

{
  "data": [ /* ... results ... */ ],
  "meta": {
    "page":     3,
    "per_page": 25,
    "total":    243    // total records matching your filters
  }
}

To detect the last page: (page - 1) * per_page + data.length >= total, or when data is empty.

Errors

Errors follow a consistent envelope. The HTTP status code communicates the category; the error.code field gives the specific machine-readable reason.

{
  "error": {
    "code":    "unprocessable",
    "message": "Validation failed",
    "details": {
      "recipient_name": ["can't be blank"],
      "service_address.zip": ["is invalid"]
    }
  }
}

Rate Limits

Each API key is limited to 1,000 requests per minute. Rate limit state is included on every response:

When you exceed the limit, you receive a 429 rate_limited response. Wait until X-RateLimit-Reset before retrying. For bulk operations, consider adding a small delay between batches to stay well under the limit.

Resources

The API is organized around these primary resources. Each has its own reference page with full endpoint documentation, parameter tables, and example requests and responses.