Skip to main content

ServCraft API and API Keys

In one sentence: A business creates its own ServCraft API key under Settings → Company → API Access, and a developer uses that key to read and send data to the account from another system.


What Is This?​

The ServCraft API lets another system or app talk to a business's ServCraft account without anyone logging in. The API Access page describes it like this: "The ServCraft API lets you extend ServCraft beyond its built-in features. Build advanced reporting, pull data into other platforms, automate workflows based on job changes, and connect ServCraft to your other business tools."

An API key is the secret the other system sends with every request so ServCraft knows which business it belongs to. Each business manages its own key on the API Access page.


Why Does This Matter?​

Because the key gives access to the account's data, it should be treated like a password and shared only with trusted developers or platforms.


How It Works​

Finding the API Access page​

Go to Settings, then API Access in the Company group of the Settings menu. The menu item only appears for the account Owner and for employees who have the Integrations permission.

Who can see and manage the key​

The page states: "Anyone with the Integrations permission will have access to the API Key." The Owner always has the Integrations permission. Super Admin on its own does not include it, and only the Owner can grant Integrations to another employee (see Roles & Permissions).

Creating a key​

  1. Open Settings → API Access.
  2. Click Create Key.
  3. The key appears in the API Key panel with the date it was created.

A business can have one active key at a time. While a key exists, Create Key is greyed out, and ServCraft refuses a second key with "An active API Key already exists".

Viewing and copying the key​

The key is hidden like a password. Click the eye icon to reveal or hide it, and the copy icon to copy it to the clipboard ("Copied" shows briefly).

Replacing a key​

  1. Click the red bin icon next to the created date.
  2. A confirmation titled Deactivate API key? warns: "Deactivating this key will revoke access for any applications or services using it."
  3. Click Deactivate.
  4. Click Create Key to make a new one, and give the new key to whoever uses the API.

A deactivated key cannot be switched back on. Any system still using the old key stops working until it is given the new one.

The page links to ServCraft API Documentation, which opens the developer reference at https://developers.servcraft.co.za/swagger/index.html in a new tab. Developers find every available request there.

Authentication​

Every API request must include the key in a request header named exactly Apikey:

Apikey: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

There is no OAuth flow. One key gives access to every available endpoint — there are no scopes or read-only mode.


What the API Can and Cannot Do​

The API mostly reads data out of ServCraft. Developers can look up and list jobs, quotes, invoices, purchase orders, customers and their assets, inventory and its categories, queries, forms, suppliers and stores. They can also download job, quote and invoice documents and print forms.

The API can create or save customers, inventory items, purchase orders and queries.

Jobs cannot be created through the API. The API Access page says so directly, and the job part of the API only offers looking up jobs, listing them and downloading job documents.

The API has no webhooks. Integrations must poll the API to detect changes — there is no way to subscribe to events.

There is no endpoint for appointments or technician schedules. If a developer needs scheduling data, it is not available through the API.

"Tickets" in customer language means Queries in the API. The Swagger documentation uses the term "Query" throughout; there is no "Ticket" endpoint.


Key Terms​

TermWhat It Means
APIA way for another system to read and send data to ServCraft automatically
API keyThe secret code that identifies the business on every API request
API AccessThe Settings page where the key is created, viewed, copied and deactivated
Integrations permissionThe employee permission that shows the API Access page; only the Owner can grant it



Important Rules & Gotchas​

  • One active key per business. Creating a new one means deactivating the old one first.
  • Deactivating is permanent. The old key cannot be reactivated, and anything using it stops working.
  • Jobs cannot be created through the API.
  • The authentication header name is Apikey (not Authorization, not Bearer).
  • There are no webhooks — integrations must poll for changes.
  • There is no endpoint for appointments or technician schedules.
  • "Tickets" in customer language are Queries in the API.