4 min read

Getting started

Make your first authenticated call in five minutes — and understand how the API maps to your work-order operations.

The FacilityOpsIQ API is a REST/JSON API that lets your PMS, ERP, or operational systems create and manage work orders and assets, subscribe to webhooks, and pull the independently verifiable trust proof for any completed job. Every request is scoped to your organization and authenticated with a Bearer API key.

Base URL

All endpoints live under the /api/v1 prefix on your FacilityOpsIQ host:

https://api.facilityopsiq.com/api/v1

1. Create an API key

In the app, go to Admin → API keys, create a key, and grant it only the scopes it needs (see Authentication). The key is shown once at creation — store it in your secret manager. Keys are prefixed wo_.

2. Make a request

Send the key as a Bearer token. Here’s a list of your open work orders:

curl "https://api.facilityopsiq.com/api/v1/records?status=ASSIGNED&limit=25" \
  -H "Authorization: Bearer wo_your_key_here"

3. Create a work order

POST the minimum fields — a category, a location/address, who’s reporting it, and what’s wrong:

curl -X POST "https://api.facilityopsiq.com/api/v1/records" \
  -H "Authorization: Bearer wo_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryId": "cat_...",
    "address": "1731 Connecticut Ave NW",
    "requesterName": "Front Desk",
    "description": "AC not cooling in room 412"
  }'

Try it live

The API reference renders every endpoint from our OpenAPI spec and includes a "try it" console you can drive with your own key against this deployment. Explore it, then build.

Open the API reference All guides