P4 Software / cifraHQ

CifraHQ API

Getting Connected to the CifraHQ API

Your Accounting data shouldn't live in a silo. The CifraHQ REST API lets you connect external systems — e-commerce platforms, warehouse management systems, third-party apps, or your own custom tooling — directly to your CifraHQ data. Create orders, post Invoices, sync Customers, pull financial data: everything available in the UI is available through the API.

The full interactive reference — every endpoint, request and response schemas, and a built-in test console — is at:

https://app.cifrahq.cloud/developers

Authentication

Every API request requires a Bearer token in the Authorization header:

Authorization: Bearer <your-api-token>

To get your API token:

  1. Log in to your CifraHQ tenant.
  2. Go to Setup > Users and open your user record.
  3. Generate or copy your API token from the API Token field.

Keep your token private — it provides the same level of access to your data as your user account.

Base URL

Your API base URL follows this pattern:

https://{yourcompany}.CifraHQ.cloud/api/

Replace {yourcompany} with your tenant subdomain — the same one you use to log in at {yourcompany}.CifraHQ.cloud.

Common endpoints

Operation Endpoint pattern
List records (with filtering) GET data/qry/{TableName}?cols=...&where=...
Get a single record by ID GET api/{Entity}/GetById?id={id}
Create or update a record POST api/{Entity}/CreateOrUpdate
Post a document POST api/{Entity}/Post
Delete a record POST api/{Entity}/Delete

Tips

  • The data/qry/ endpoint behaves like a parameterised SQL query — use cols, where, joins, order, limit, and offset to pull exactly the list data you need, including cross-table joins, without writing a custom endpoint.
  • All entity IDs in CifraHQ are GUIDs. Store them as strings; do not truncate or reformat them.
  • Dates use ISO 8601 format: 2025-04-24T00:00:00Z.
  • All requests and responses use application/json.

Full API reference: https://app.cifrahq.cloud/developers

Related: Users · Webhooks · Workflows

Was this page helpful?