v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-211931021.7 MB

Clients

Retrieve a Client

OAuth Scope

This endpoint requires the following OAuth scope read_customers.

get/company/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Client

Response

Client record retrieved successfully

namestring required

Company Name

abn_numberstring

Australian Business Number. A unique 11-digit identifier issued by the Australian Taxation Office to businesses. Required for tax compliance and validation of business identity in Australia.

addressstring

Password

billing_addressstring

Confirm Password

is_individual0 | 1

Derived flag indicating whether the client is an individual. This value is set automatically based on the company name and contact first/last name, and cannot be set via the API.. Valid values are [0,1]

{"stackTrail":"components:schemas:Company:properties:parent_company_uuid","oasType":"schema","type":"unknown","description":"If provided, specifies the UUID of this Site's parent Company. If blank, this record is a Head Office rather than a Site. This field is only present on ServiceM8 Accounts with the Company Sites addon activated."}

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

websitestring

address_streetstring

address_citystring

address_statestring

address_postcodestring

address_countrystring

fax_numberstring

badgesstring

JSON Array of Badge UUIDs

tax_rate_uuidstring uuid

billing_attentionstring

payment_termsstring

Example response

{
  "uuid": "123e4567-d900-4b77-9a4a-23f943cc1dcb",
  "edit_date": "2026-03-01 12:00:00",
  "tax_rate_uuid": "123e4567-f71c-4478-8120-23f9441f6b2b"
}