v50

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

Company Contacts

Retrieve a Company Contact

OAuth Scope

This endpoint requires the following OAuth scope read_customer_contacts.

get/companycontact/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Company Contact

Response

Company Contact record retrieved successfully

company_uuidstring uuid

The UUID of the company this contact belongs to

firststring

First name of the company contact. Used for identifying and addressing the contact in communications.

laststring

Last name of the company contact. Used together with the first name to identify the contact.

phonestring

Primary phone number for the contact. Used for voice communications with the contact. Should include area code and can include international code.

mobilestring

Mobile phone number for the contact. Used for SMS communications and alternative voice contact. Should include area code and can include international code.

emailstring email

Email address of the contact. Used for sending email communications, quotes, invoices, and other electronic correspondence.

typestring

Specifies the type of contact. Common values include 'BILLING' for billing contacts and 'JOB' for job contacts. This field determines how the contact is used in the system.

is_primary_contactstring

Indicates whether this contact is the primary contact for the company. Value of 1 means this is the primary contact, 0 means it is not. A company should have only one active primary contact.

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

Example response

{
  "company_uuid": "123e4567-b8f0-4e5d-97c7-23f9457c480b",
  "uuid": "123e4567-899e-40c5-b9be-23f9485b414b",
  "edit_date": "2026-03-01 12:00:00"
}