GraphQL Queries (Read)

Fetch data with type-safe GraphQL queries

5 min read

The GraphQL endpoint at /api/v1/graphql supports 7 read queries that mirror the most-used REST endpoints: whoami, workOrders, workOrder(id), assets, asset(id), parts (with lowStock filter), locations, vendors, customers.

Endpoint

POST https://freemaint.com/api/v1/graphql with Content-Type: application/json. Each query consumes 1 from your daily quota.

Example: list work orders

Query { workOrders(limit: 10, status: "OPEN") { id title priority status assetId locationId dueDate } }. Returns up to 200 rows; default limit is 50.

Available filters

  • workOrders(limit, status) โ€” limit 1-200, status string filter
  • assets(limit) โ€” limit 1-200
  • parts(limit, lowStock) โ€” lowStock=true returns only items below minQuantity
  • locations, vendors, customers โ€” return up to 200 rows ordered by name

Schema introspection

Introspection is enabled โ€” point Apollo Sandbox or GraphiQL at /api/v1/graphql with your Bearer token to explore the full schema interactively.

Tip

Combine multiple queries in one request: { workOrders(limit:5){ id } assets(limit:5){ id } } โ€” counts as 1 quota hit.

Was this page helpful?