Skip to content

Contacts Object



id
string
REQUIRED · 

The unique identifier for the contact

name
string

The name of the contact

type
string

The type of the contact

All possible enum values:
  • customer
  • vendor
emails
object[]

The emails of the contact

email
string

The email of the contact

type
string

The type of the email

tax_number
string

The tax number of the contact

status
string

The status of the contact

All possible enum values:
  • active
  • archived
currency
string

The currency of the contact

company
string

The ID of company the contact belongs to

addresses
object[]

The addresses of the contact

id
string

The unique identifier for address

street_1
string

The street 1 address of the contact

street_2
string

The street 2 address of the contact

city
string

The city of the contact

state
string

The state of the contact

country
string

The country of the contact

postal_code
string

The postal code of the contact

type
string

The type of the address

phones
object[]

The phone numbers of the contact

number
string

The phone number of the contact

extension
string

The extension of the phone number

type
string

The type of the phone number

created_at
string · date-time

This represents the date when the contact was created

updated_at
string · date-time

This represents the date when the contact was updated

remote_data
object

Raw data returned from the remote API call.