Skip to main content
You can integrate Gorelo with any external product through the Gorelo API. The Gorelo API uses API keys. Include your key in every request via the X-API-Key header. The Gorelo base URL depends on the region you opted to host your data on in Gorelo:
Endpoint pages in the API reference use the US base URL by default. If your data is hosted in Australia, click the base URL at the top of the endpoint page and select https://api.aue.gorelo.io.
Base URL menu on an endpoint page with https://api.aue.gorelo.io selected

Example requests

The following JavaScript fetch snippets show how to authenticate with the X-API-Key header. Replace YOUR_API_KEY with your key and swap the base URL for the region hosting your data.
GET
POST

Scopes and permissions

You can scope API keys. If a key lacks access to an endpoint, the API returns 403 Forbidden. The Documents scope gives a key access to documents.

Custom fields

Custom fields in API responses include IsSet and IsHidden. To keep a custom field’s value out of the API, turn on Hide Value from API for that field.

Import history

When you import records with a backdated CreatedOn, Gorelo sends no notifications and triggers no automations.
Gorelo saves time entries you import with CreatedOn as Completed, so they won’t be invoiced. You can’t change or delete them through the API afterward.

Error handling

Status IDs

Agent assets

Field and value notes

Alerts

Alerts identify the asset they relate to with AgentAssetId, CustomAssetId, or UptimeId. Use the same fields to filter alerts.
DeviceId and UptimeCheckId are deprecated aliases of AgentAssetId and UptimeId. Update your integrations to use the current field names.

Contracts and invoices

  • Contract fields: Contract responses return DaysUntilDue, UnitCost on line items, and AutoApproveTime on the service line.
  • Contract line prices: UnitPrice on a contract line returns the price actually charged, not the catalog price.
  • Billable lines: POST /v1/invoices bills No charge and Non-billable lines at 0. Send BillableStatusId 1 for lines that should be charged.
  • Tax: Invoice and contract lines without a TaxId get the tax the app would apply. To bill no tax, send your tax-exempt rate’s ID.
  • Deleting contracts: DELETE /v1/contracts/{contractId} deactivates the contract, like the app does, so you can recover it. To archive a contract instead, send PATCH with StatusId 3. Send StatusId 1 to restore an archived contract.
  • Contract lines: On PATCH /v1/contracts/{contractId}, Gorelo matches service lines and line items by Id. The lines you send replace the contract’s existing set, so include every line you want to keep.
Related item type 4 on documents is Agent asset. Integrations that match on the type ID keep working. Integrations that match on the type name must use Agent asset.