Clients

Retrieve a Client

Changed on

OAuth Scope

This endpoint requires the following OAuth scope read_customers.

get/company/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/company/{uuid}.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: read_customers

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]

parent_company_uuidunknown
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"
}

Changes

  • 509ed0fe9958Revision changes
    • breaking

      the response's property type changed from string to integer for status

    • warning

      added the new 0.00 enum value to the response property for the response status

    • warning

      added the new 1.00 enum value to the response property for the response status

    • info

      the response optional property became read-only for the status

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status