Get Contacts Lists

Use this method to get Contacts lists. See our HTTP GET documentation for complete queries method.

The following elements are returned in the get Contacts lists methods response :

Body Response

Element	Description
id	Contact id. String. Automatically
code	Contact code. String maximum 255 characters.
name	Contact name String maximum 255 characters.
bussiness_id_number	Bussiness id number String maximum 35 characters.
tax_id_number	Tax id number String maximum 35 characters.
is_customer	Boolean true if Customer false if not customer.
is_supplier	Boolean true if Supplier false if not Supplier.
is_employee	Boolean true if Employee false if not Employee.
is_active	Boolean true if active customer false if not active customer.
credit_limit	Credit limit given to Customer or Vendor type Number.
term_of_payment*	Element of term of payment.
term_of_payment.due_days	Due date period of credit transaction, for customer and vendor type Integer.
term_of_payment.late_charge	Credit transaction late charge Integer.
term_of_payment.discount_days	Discount day, for customer and vendor type Integer.
term_of_payment.early_discount	Early discount, for customer and vendor type Integer.
classification*	Element of Contact Classification.
classification.id	Unique code for identifier contact classification.
classification.name	Classification name String.
default_currency*	Element of default Currency.
default_currency.id	Unique code for identifier Currency.
default_currency.code	Currency code String maximum 3 characters.
default_currency.name	Currency name String maximum 255 characters.
default_currency.symbol	Currency symbol String.
created*	Element of Created.
created.user*	Element of Created User.
created.user.id	User id String.
created.user.name	User name String.
created.user.email	User email String.
created.time	Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.
update*	Element of Update.
update.user*	Update user.
update.user.id	User id String.
update.user.name	User name String.
update.user.email	User email String.
update.time	Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.
addresses*	Element of addresses
addresses.id	Address id.
addresses.is_primary	Boolean true if primary false if not primary.
addresses.type	Addresses type String Billing Address or Shipping Address.
addresses.complete_address	Complete addresses String.
addresses.district	District addresses String.
addresses.city	City name String.
addresses.state	State name String.
addresses.country_code	Country Code String.
addresses.country_name	Country name String.
addresses.postal_code	Postal Code String.
addresses.latitude	latitude addresses String.
addresses.longitude	longitude addresses String.
phones*	Element of phones String.
phones.id	Phones id String.
phones.is_primary	Boolean true if primary false if not primary.
phones.type	Phones type String Ex: Handphone or Telephone
phones.value	Phones Number String.
emails*	Element of emails String.
emails.id	Emails id String.
emails.is_primary	Boolean true if primary false if not primary.
emails.type	Email type String Ex: office email or personal email
emails.value	Email Address String.
contact_persons*	Element of Contacts person.
contact_persons.id	Contact persons id String.
contact_persons.is_primary	Boolean true if primary false if not primary.
contact_persons.designation	Contact persons type String Ex: Manager, Staff, Office Boy
contact_persons.name	Contact persons name String.
other_fields*	Element of other fields.
other_fields.id	other_fields id String.
other_fields.key	other_fields key String.
other_fields.type	other_fields data type Ex: string or integer or number
other_fields.value	value of other_fields String.
attachments*	Element of attachments.
attachments.id	Attachments id String.
attachments.name	Attachments name String.
attachments.extension	Attachments extension Ex: JPG, Doc, PDF String.
attachments.url	Attachments url String.