Schema ListContacts200Response

ListContacts200Response (object)

Field

Type

Description

data*

object[]

array

Elements

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

avatar

object

Field	Type	Description
id	integer	—
url	string	—

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

fields

object[]

List of contact field values

array

Elements

Field	Type	Description
id*	integer	Field ID
key*	string	Field key
value*	object	Value of the field

first_name

string

—

gender

string

female
male
diverse

group_ids

integer[]

array

Elements

integer

groups

object[]

List of groups associated with the contact.

array

Elements

Field	Type	Description
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent

object

Field

Type

Description

additional_name

string

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

bank_bic

string

Bank BIC/SWIFT code

bank_iban

string

Bank IBAN

birthdate

string (date)

Birthdate of the contact in ISO 8601 format.

buyer_reference

string

—

cash_discount_days

integer

Cash discount days for the contact.

cash_discount_rate

number (float)

Cash discount percentage for the contact.

city

string

City of the address.

company_name

string

Company name (used as name_line_3 in document addresses).

contact_number

integer

—

country_code

string

ISO country code of the address.

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

creditor_number

integer

—

custom_data

object

—

customer_discount_rate

number (float)

Customer-specific discount percentage.

debtor_number

integer

—

delivery_terms

string

—

emails

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (email)	—

first_name

string

—

gender

string

female
male
diverse

id*

integer

—

internal_note

string

HTML

is_organisation*

boolean

—

last_name

string

—

name*

string

—

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

parent_id

integer

—

payment_term_days

integer

—

payment_terms

string

—

phones

object[]

array

Elements

Field	Type	Description
name	string	—
value	string	Phone number in E.164 format.

position

string

Position of the contact in the organisation.

quote_due_days

integer

—

reference_key

string

—

sepa_creditor_id

string

—

state

string

State or region of the address.

status*

string

Contact lifecycle status. List endpoints default to active contacts when omitted.

string

active
archived

tax_id

string

Tax ID

title

string

Title of the contact (e.g., Mr., Mrs.).

type*

string

organisation
person

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

vat_id

string

VAT ID

websites

object[]

array

Elements

Field	Type	Description
name	string	—
value	string (https://test.com)	—

zip

string

ZIP or postal code.

meta*

object

Field	Type	Description
current_page*	integer	The current page number.
items_from*	integer	The starting item number on the current page.
items_to*	integer	The ending item number on the current page.
last_page*	integer	The last page number.
per_page*	integer	The number of items per page.
total*	integer	The total number of items.

Example (JSON)

{
  "data": [
    {
      "id": 0,
      "parent_id": 0,
      "parent": {
        "id": 0,
        "parent_id": 0,
        "type": "organisation",
        "is_organisation": true,
        "name": "string",
        "company_name": "string"
      },
      "type": "organisation",
      "is_organisation": true,
      "name": "string",
      "status": "active"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "items_from": 1,
    "items_to": 1
  }
}