Services

A service is a reusable template for the work you do — "Standard Diagnostic", "Battery Replacement", "Annual Tune-Up". Each service carries its own pricing model (fixed, hourly rate, or variable) and optional warranty defaults that flow through to quotes and invoices.

Endpoints

GET/organisations/{orgId}/services — List service templates (paginated)
POST/organisations/{orgId}/services — Create service template
GET/organisations/{orgId}/services/{serviceId} — Get service
PUT/organisations/{orgId}/services/{serviceId} — Update service
DELETE/organisations/{orgId}/services/{serviceId} — Delete service

List supports search (matches title and description) plus standard cursor pagination via limit and startAfter.

Pricing models

`priceType`	Meaning
`fixed`	A flat price regardless of duration
`rate`	A per-unit rate — set `priceTimeRate` to `hour`, `day`, `week`, or `month`
`variable`	Quoted on a per-job basis; the `price` field is treated as a starting point

Authorization

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

Query Parameters

limit?integer

Maximum number of items to return (max 100)

Range1 <= value <= 100

Default50

startAfter?string

Cursor for pagination - ID of the last item from previous page

search?string

Response Body

`application/json`

curl -X GET "https://example.com/organisations/string/services"

{  "success": true,  "data": {    "services": [      {        "id": "string",        "title": "string",        "description": "string",        "notes": "string",        "priceType": "fixed",        "price": 0,        "costPrice": 0,        "priceTimeRate": "hour",        "warranty": true,        "warrantyDuration": 0,        "warrantyPeriod": "day",        "quantity": 0,        "taxRateId": "string",        "index": 0,        "createdAt": "2019-08-24T14:15:22Z"      }    ],    "pagination": {      "limit": 0,      "hasMore": true,      "nextCursor": "string"    }  }}

{  "success": false,  "error": "An error occurred"}

{  "success": false,  "error": "You do not have access to this organisation"}

Authorization

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

description?string

notes?string

priceType?string

Value in

"fixed"
"rate"
"variable"

price?number

costPrice?number

priceTimeRate?string

Value in

"hour"
"day"
"week"
"month"

warranty?boolean

warrantyDuration?integer

warrantyPeriod?string

Value in

"day"
"week"
"month"
"year"

quantity?number

taxRateId?string

index?integer

Response Body

`application/json`

curl -X POST "https://example.com/organisations/string/services" \  -H "Content-Type: application/json" \  -d '{    "title": "string"  }'

{  "success": true,  "data": {    "id": "string",    "title": "string",    "description": "string",    "notes": "string",    "priceType": "fixed",    "price": 0,    "costPrice": 0,    "priceTimeRate": "hour",    "warranty": true,    "warrantyDuration": 0,    "warrantyPeriod": "day",    "quantity": 0,    "taxRateId": "string",    "index": 0,    "createdAt": "2019-08-24T14:15:22Z"  }}

{  "success": false,  "error": "An error occurred"}

{  "success": false,  "error": "An error occurred"}

{  "success": false,  "error": "You do not have access to this organisation"}

Authorization

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

serviceId*string

Response Body

`application/json`

curl -X GET "https://example.com/organisations/string/services/string"

{  "success": true,  "data": {    "id": "string",    "title": "string",    "description": "string",    "notes": "string",    "priceType": "fixed",    "price": 0,    "costPrice": 0,    "priceTimeRate": "hour",    "warranty": true,    "warrantyDuration": 0,    "warrantyPeriod": "day",    "quantity": 0,    "taxRateId": "string",    "index": 0,    "createdAt": "2019-08-24T14:15:22Z"  }}

{  "success": false,  "error": "An error occurred"}

{  "success": false,  "error": "You do not have access to this organisation"}

{  "success": false,  "error": "An error occurred"}

Authorization

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

serviceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

description?string

notes?string

priceType?string

Value in

"fixed"
"rate"
"variable"

price?number

costPrice?number

priceTimeRate?string

Value in

"hour"
"day"
"week"
"month"

warranty?boolean

warrantyDuration?integer

warrantyPeriod?string

Value in

"day"
"week"
"month"
"year"

quantity?number

taxRateId?string

index?integer

Response Body

`application/json`

curl -X PUT "https://example.com/organisations/string/services/string" \  -H "Content-Type: application/json" \  -d '{    "title": "string"  }'

{  "success": true,  "data": {    "id": "string",    "title": "string",    "description": "string",    "notes": "string",    "priceType": "fixed",    "price": 0,    "costPrice": 0,    "priceTimeRate": "hour",    "warranty": true,    "warrantyDuration": 0,    "warrantyPeriod": "day",    "quantity": 0,    "taxRateId": "string",    "index": 0,    "createdAt": "2019-08-24T14:15:22Z"  }}

{  "success": false,  "error": "An error occurred"}

{  "success": false,  "error": "An error occurred"}

{  "success": false,  "error": "You do not have access to this organisation"}

{  "success": false,  "error": "An error occurred"}

Authorization

X-API-Key<token>

API key for authentication. Get your key from the Developer Dashboard.

In: header

Path Parameters

orgId*string

Organisation ID

serviceId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/organisations/string/services/string"

{  "success": true,  "data": {    "message": "Operation completed successfully"  }}

{  "success": false,  "error": "An error occurred"}

{  "success": false,  "error": "You do not have access to this organisation"}

{  "success": false,  "error": "An error occurred"}

Machine-readable version: OpenAPI 3.1 spec.

Services

200application/json

401application/json

403application/json

Cross-organisation access

OAuth missing scope

Pro subscription required

201application/json

400application/json

401application/json

403application/json

Cross-organisation access

OAuth missing scope

Pro subscription required

200application/json

401application/json

403application/json

404application/json

Cross-organisation access

OAuth missing scope

Pro subscription required

200application/json

400application/json

401application/json

403application/json

404application/json

Cross-organisation access

OAuth missing scope

Pro subscription required

200application/json

401application/json

403application/json

404application/json

Cross-organisation access

OAuth missing scope

Pro subscription required

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`