API DOCUMENTATION
Build on the Phixall platform.
Use our REST API to create service requests, monitor Phixer activity, synchronize wallets, and automate your facility operations workflows. This guide covers environments, authentication, and the core endpoints you need to get started.
Production
Live environment for real clients and Phixers.
Sandbox
Use this for testing. Data resets every Sunday at 00:00 GMT.
Authentication
Authenticate every request using your secret API key via the Authorization header.
GET /v1/requests HTTP/1.1 Host: api.phixall.com Authorization: Bearer YOUR_API_KEY Content-Type: application/json
For server-to-server integrations, rotate keys every 90 days and store them securely (e.g., Vault, AWS Secrets Manager).
Webhooks
Receive real-time notifications when a request status changes, an Phixer starts a job, or a wallet payout clears.
- request.updated — Every status update and assignment change.
- wallet.payout.created — When a payout is initiated.
- wallet.payout.settled — When a payout succeeds.
Use the X-Phixall-Signature header to verify webhook authenticity.
Core Endpoints
Requests & Wallets
These are the most commonly used endpoints for facility management workflows.
/v1/requestsCreate Service Request
Create a new maintenance/service request on behalf of a client.
Request Body
- clientIdRequired — Phixall client ID (string)
- titleRequired — Short summary of the request (string)
- descriptionRequired — Detailed description (string)
- categoryRequired — plumbing | electrical | hvac | carpentry | cleaning | custom (string)
- scheduledAt — Optional preferred time (ISO8601 string)
- locationRequired — { address, city, state, lat, lng } (object)
/v1/requestsList Requests
Retrieve paginated requests filtered by status or client.
Query Parameters
- status — requested | accepted | in-progress | completed (string)
- clientId — Filter by client (string)
- page — Defaults to 1 (number)
- pageSize — Defaults to 20, max 100 (number)
/v1/requests/{requestId}Update Request Status
Update the status of an existing request, assign an Phixer, or attach verification data.
Request Body
- status — accepted | in-progress | completed | cancelled (string)
- phixerId — Optional Phixer assignment (string)
- verification — { completedBy, notes, attachments } (object)
/v1/wallets/{userId}Wallet Snapshot
Returns current wallet balance, credits, and pending payouts for a user.
Need more?
Enterprise & Partner Integrations
Let us know if you need premium webhooks, SLA-backed response windows, or custom scopes. Our platform team will set up a discovery call within 1 business day.