Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• pageNumber integer

  Page Number

  Default value is 1.

• sortingField string

  Field to sort by

• direction string

  Sorting direction

  Values are ASC or DESC. Default value is ASC.

• sizePerPage integer

  Size per page

  Default value is 60.

• id string

  Contact ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• contactType string

  Contact type filter

  Values are ORGANIZATION or PERSON.

• name string

  Contact name filter. Applicable only when contactType = ORGANIZATION

• isCustomer boolean

  Whether the contact is a customer

• isVendor boolean

  Whether the contact is a vendor/supplier

• isStaff boolean

  Whether the contact is a staff member. Applicable only when contactType = PERSON

• isUser boolean

  Whether the contact has a user account. Applicable only when contactType = PERSON

• email string

  Email address filter

• externalId string

  External identifier filter

• archived boolean

  Whether the contact is archived

• hasWarnings boolean

  Whether the contact has warnings

• lastName string

  Last name filter. Applicable only when contactType = PERSON

• firstName string

  First name filter. Applicable only when contactType = PERSON

• middleName string

  Middle name filter. Applicable only when contactType = PERSON

• nationality string

  Nationality filter. Applicable only when contactType = PERSON

• gender string

  Gender filter. Applicable only when contactType = PERSON

  Values are MALE, FEMALE, or OTHER.

• birthDate string(date-time)

  Birth date filter. Applicable only when contactType = PERSON

• language string

  Default language filter

  Values are EN, FR, DE, IT, or UNDEFINED.

• nogaCode string

  NOGA economic activity code filter. Applicable only when contactType = ORGANIZATION

• phone string

  Phone number filter

• fax string

  Fax number filter

• mobile string

  Mobile number filter

• webSite string

  Website URL filter

• addressId string

  Address ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• addressName string

  Address label / name filter

• addressStreet string

  Address street filter

• addressHouseNumber string

  Address house number filter

• addressStreetPoBox string

  Address P.O. box / street line 2 filter

• addressCity string

  Address city filter

• addressPostCode string

  Address postal code filter

• addressCountry string

  Address country filter

• addressRegion string

  Address region filter

• addressToTheAttentionOf string

  Address 'to the attention of' filter

• bankId string

  Bank ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• bankName string

  Bank account label / name filter

• bankAccountNumber string

  Bank account number filter

• bankSwiftBic string

  Bank SWIFT/BIC code filter

• bankRemark string

  Bank account remark filter

• clientDefaultDepartmentId string

  Client default department ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• clientDefaultAccountForPaymentsNumber integer(int64)

  Client default payment chart of accounts number filter

• clientDefaultPlAccountNumber integer(int64)

  Client default P&L chart of accounts number filter

• clientDefaultBalanceSheetAccountNumber integer(int64)

  Client default balance sheet chart of accounts number filter

• clientDefaultPaymentCurrencyCode string

  Client default payment currency code filter

• clientVatNumber string

  Client VAT number filter

• clientVatType string

  Client VAT type filter

• clientRequestedPaymentTerms integer(int64)

  Client requested payment terms in days filter

• clientLateNoticeMargin integer(int64)

  Client late notice margin in days filter

• clientDiscountRate number

  Client discount rate filter

• clientCreditLimit string

  Client credit limit filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• supplierDefaultDepartmentId string

  Supplier default department ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• supplierDefaultAccountForPaymentsNumber integer(int64)

  Supplier default payment chart of accounts number filter

• supplierDefaultPlAccountNumber integer(int64)

  Supplier default P&L chart of accounts number filter

• supplierDefaultBalanceSheetAccountNumber integer(int64)

  Supplier default balance sheet chart of accounts number filter

• supplierDefaultPaymentCurrencyCode string

  Supplier default payment currency code filter

• supplierVatNumber string

  Supplier VAT number filter

• supplierVatTypeEnum string

  Supplier VAT type filter

  Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.

• supplierVatTypeCode string

  Supplier VAT type code filter

• supplierRequestedPaymentTerms integer(int64)

  Supplier requested payment terms in days filter

• supplierPaymentFeesSplit string

  Supplier payment fees split filter

  Values are CHARGED_TO_THE_BENEFICIARY, FIFTY_FIFTY_SPLIT, or CHARGED_TO_THE_ORDERER.

• staffAvsNumber string

  Staff AVS/social security number filter. Applicable only when contactType = PERSON

• staffPermitExpiryDate string

  Staff work permit expiry date filter. Applicable only when contactType = PERSONSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• staffContractType string

  Staff contract type filter. Applicable only when contactType = PERSON

  Values are OPEN_ENDED, OPEN_ENDED_YEAR, FIXED, APPRENTICESHIP, or INTERN.

• staffMaritalType string

  Staff marital status filter. Applicable only when contactType = PERSON

  Values are SINGLE, MARRIED, DIVORCED, SEPARATED, WIDOWED, PARTNERED, DISSOLVED_LAW, DISSOLVED_LOST, or DISSOLVED_DEATH.

• staffTrainingLevel string

  Staff training level filter. Applicable only when contactType = PERSON

  Values are PHD, MASTER_ETH, BACHELOR_ETH, MASTER_UAS, BACHELOR_UAS, HES, MASTER, BACHELOR, TC, MATU, CVT, IN_HOUSE, or COMP_SCHOOL.

• staffPosition string

  Staff position filter. Applicable only when contactType = PERSON

  Values are SENIOR, MIDDLE, LOWER, or RESP.

• status string

  Contact status filter

  Values are ACTIVE or ARCHIVED.

• filterStaffContacts boolean

  Whether to filter for staff contacts only

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • organizationId integer(int64)
  • contactType string

    Values are ORGANIZATION or PERSON.

  • name string
  • warnings string
  • isCustomer boolean
  • isVendor boolean
  • isStaff boolean
  • isUser boolean
  • email string
  • externalId string
  • clientOrderValidity integer(int64)
  • creatorContactId integer(int64)
  • archived boolean
  • hasWarnings boolean
  • isEmployee boolean
  • tenantId integer(int64)
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error