List provinces

Developing

GET

/settings/provinces

Provinces are a list of county/states and are used when adding properties (either customers, companies or work addresses).

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

🟠429429 Too many requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/settings/provinces?includeCount=true' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": [
        {
            "id": 0,
            "createdOnDateTime": "string",
            "lastUpdatedOnDateTime": "string",
            "province": "string"
        }
    ],
    "meta": {
        "totalRecords": 0,
        "serverTime": "string"
    },
    "pagination": {
        "hasMore": true,
        "nextCursor": 0,
        "prevCursor": 0
    }
}

Modified at 2026-04-06 12:49:59

List opportunity stages

List job description templates