v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB

Contacts

Retrieve contact

Endpoint for retrieving a single contact.

get/contacts/{id}/

Path parameters

idstring required

Response

additional_numberstring

Additional number for the address, if applicable.

addressstring

The street address of the contact.

attachmentsstring[]

A list of attachments associated with this contact.

beneficiariesstring[] required

The Beneficiaries associated with Contacts

building_numberstring

The building number. Should be 4 digits for KSA addresses. For other countries, follow local conventions.

citystring

The city where the contact is located.

codestring

The unique contact code used for identification purposes.

country'SA' | 'AE' | 'QA' | 'BH' | 'KW' | 'OM' | 'EG' | 'US' | 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CD' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MK' | 'MP' | 'NO' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VA' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW'

SA - Kingdom of Saudi Arabia
AE - United Arab Emirates
QA - Qatar
BH - Bahrain
KW - Kuwait
OM - Oman
EG - Egypt
US - United States of America
AF - Afghanistan
AX - Åland Islands
...

Full information for CountryEnum

created_tsstring date-time required

The timestamp in UTC when the contact was created

{"stackTrail":"components:schemas:api-v1-external-contact-read-write:properties:custom_fields","oasType":"schema","type":"unknown","description":"The custom fields of the contact."}

districtstring

The district or neighborhood within the city where the contact is located.

emailstring email

The primary email address for contacting the contact.

external_idstring

External identifier for the contact.

idstring required

The unique identifier of the contact object. This field is read-only.

legacy_idstring required

[Deprecated] The legacy identifier of the contact.

modified_tsstring date-time required

The timestamp in UTC when the contact was last modified

namestring required

The full name or business name of the contact.

personsstring[] required

The associated persons for the contact.

phonestring

The primary phone number for contacting the contact.

postal_codestring

The postal code or ZIP code. Should be 5 digits for KSA addresses. For other countries, follow local postal code formats.

tax_registration_numberstring

The tax registration number of the contact, if applicable.

Example response

{
  "company_identification": [
    {
      "value": "1234567890"
    }
  ]
}