canonical: https://jentic.com/apis/aroflo.com/aroflo

# AroFlo API

Jentic publishes the only available OpenAPI specification for AroFlo API, keeping it validated and agent-ready. AroFlo is a field service management platform used by trade businesses, and its REST API exposes a single query endpoint that pulls data across resource zones - jobs, quotes, invoices, timesheets, and contacts - with query parameters for filtering, joining related zones, and paginating. Authentication uses HMAC-SHA512 signatures on the Authentication header. Responses come back as XML or JSON.

## For AI agents

Pull field service data from AroFlo (jobs, quotes, invoices, timesheets, contacts) using the unified resource-zone query endpoint with HMAC-SHA512 authentication.

## Scope

Does not handle payment processing, GPS tracking, or document signing - use for querying AroFlo job, quote, invoice, and timesheet data only.

## Capabilities

- Query AroFlo data across resource zones such as jobs, quotes, invoices, and timesheets
- Filter results using zone-specific query parameters
- Join related zones in a single query (e.g. jobs with their associated invoices)
- Paginate through large result sets
- Receive responses in XML or JSON format

## Use cases

### Field Service Reporting Sync

Sync AroFlo job and invoice data into a reporting warehouse for trade business owners who want unified visibility across operations and finance. The single query endpoint returns the requested resource zone with joins, so a nightly sync can land the day's jobs, invoices, and timesheets into BigQuery or Snowflake without writing zone-specific clients.

Example prompt: Query AroFlo for all jobs modified in the last 24 hours, join with their invoices, and write the resulting rows to a Snowflake staging table

### Operations Dashboard

Power a live operations dashboard for a trade business by querying AroFlo for open jobs, scheduled timesheets, and outstanding invoices. The unified endpoint with filter and join parameters keeps the integration small - one HTTP call surface to maintain, even as the dashboard pulls more zones over time.

Example prompt: Query AroFlo for jobs with status 'open' and an associated invoice status of 'unpaid', then push the count to a dashboard tile

### Customer Portal Data

Drive a customer-facing portal where clients see their own jobs, quotes, and invoices by querying AroFlo with the client id filter. Responses can be requested as JSON for direct consumption by a web frontend without additional XML parsing.

Example prompt: Query AroFlo for all jobs and invoices belonging to client id 1024, return JSON, and render them on the client portal page

### Agent-Driven Job Lookup via Jentic

Let an internal AI assistant answer questions like 'is the Smith Street rewire job invoiced yet?' by calling AroFlo through Jentic. The agent searches Jentic for 'query AroFlo jobs', loads the schema for the unified query endpoint, and executes - without managing the HMAC signing flow itself.

Example prompt: Search Jentic for 'query AroFlo jobs', load the schema, and execute a query joining jobs with invoices for the last 7 days

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/` | Unified resource-zone query endpoint with filter, join, and pagination parameters |

## Key resources

- **Resources Query** — Single endpoint that accepts a zone parameter to query jobs, quotes, invoices, timesheets, contacts, and related entities

## Why Jentic

- **Setup:** Wiring AroFlo by hand means computing its HMAC-SHA512 signature on every request from a key and secret, then hitting its single unified query endpoint with the right zone and filter arguments. Through Jentic you install once, import the AroFlo API from the API Directory, store the key and secret once, and your agent calls it while Jentic computes the signature.
- **Permission scoping:** AroFlo exposes a single unified query operation rather than per-resource URL paths, so a rule can limit the agent to the operations it needs, such as querying jobs or invoices. You choose the operations it may call, so the agent runs only the read queries you allow.
- **Credential handling:** Your AroFlo key and secret are stored once, encrypted, by your own Jentic One instance, and the HMAC signature is computed at execution time. The signing material never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'query AroFlo jobs' or 'list AroFlo invoices', and Jentic returns the unified query operation with its zone, filter, and join parameters in schema so the agent posts the right shape without reading the docs.

## Related APIs

- **Toggl API** — Toggl tracks time entries that can be reconciled against AroFlo timesheets
- **HubSpot CRM Contacts API** — HubSpot manages the marketing and sales side of customer relationships; AroFlo manages the field service execution side
- **Calendly API** — Calendly books on-site appointments that AroFlo then turns into scheduled jobs

## FAQ

### Why is there no official OpenAPI spec for AroFlo API?

AroFlo does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call AroFlo API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the AroFlo API use?

AroFlo uses HMAC-SHA512 signed requests. The signature is passed in the Authentication header along with the issued API key. Through Jentic, the key and HMAC signing material are stored encrypted in the vault and applied at execution, so the agent never sees the raw secret.

### Can I fetch invoices for a specific client with the AroFlo API?

Yes. The single query endpoint accepts a zone parameter set to invoices and additional filter parameters such as the client id. Combine with a join parameter to also pull associated jobs in the same response.

### What are the rate limits for the AroFlo API?

AroFlo does not publish a hard public rate limit; the API is intended for back-office sync and dashboard queries rather than per-second polling. Cache results and prefer larger paginated queries over many small ones.

### How do I query open jobs through Jentic?

Run pip install jentic, then search Jentic with 'query AroFlo jobs', load the returned schema for the GET / endpoint, and execute with the zone parameter set to 'jobs' and a filter for status. Jentic handles the HMAC signing for you.

### Can I get JSON responses instead of XML?

Yes. AroFlo's query endpoint supports both XML and JSON output; pass the appropriate format query parameter so a downstream pipeline can consume JSON directly.

### Can I limit what my agent is allowed to do with the AroFlo API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials your agent may use. AroFlo exposes a single unified query operation rather than per-resource paths, so you can scope the agent to only the reads it needs, such as querying jobs or invoices, and block the rest. Since you choose the operations it may call, the agent runs only the queries you allow.