Retrieves all the contacts
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "6f4cab63-8298-42f4-a4e4-c4ea20278974",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "68a8771b-5b4e-49dc-80bd-9f806c1957b7",
"company_code": "sample string 5",
"company": {
"id": "332285a8-2bef-4313-8357-c6f7f7ff5063",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-16T22:42:23.9115966+00:00",
"sales_territory_id": "86ada7ba-3e63-49eb-810e-60e48ddf584a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0666ce75-a698-4388-bcab-f659e7babe4f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fdb71e58-a1ca-4a81-aeb7-d2f40b77ec37",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08807781-7460-40a0-bbd6-bbc32f2cbd5c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a721e32e-caf9-47fb-ba0e-f1a5bbef7f09",
"db_currency_id": "5656055b-4df8-483f-9c4b-ab803a09f7c8",
"db_language_id": "999c2ddb-9798-4083-b4cd-6c99c160d08f",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-09-16T22:42:23.9115966+00:00"
},
"modified_dateutc": "2025-09-16T22:42:23.9115966+00:00"
},
"marketing_segment_id": "fdd16a21-7896-4de7-9b15-6d0f5297e6e8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9f79fa8b-6aff-4c51-a0be-4c7f30e75ae9",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "abb6b172-a787-4586-917b-000f57b22fca",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "56b3b384-7120-4113-b374-53ce023253ad",
"db_country_code": "sample string 28",
"feelist_id": "f5eb965f-b2f3-45df-9d11-8c2b716fff27",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "81f9abe9-0b14-4689-918c-59f5836e8219",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cd395481-2325-46a6-ae28-c8f2f6d9804d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-16T22:42:23.9115966+00:00",
"db_currency_id": "7cf36a76-6ffd-4353-b7cb-d4584c8b37e9",
"db_currency_code": "sample string 10"
},
"company_type_id": "a2b07856-49b9-43d3-aaca-08abdbd71f4e",
"company_type_name": "sample string 32",
"company_type": {
"id": "5dfa38cb-a5ac-46f7-b915-3c424e149fd2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "653a7a7c-82b3-4e38-be9b-286ec51471d4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "04dd9374-ed7b-4374-86af-0324ecb38e5f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "765324f2-3deb-4bfd-873e-b37e8acf3901",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "12223dff-f33f-47d6-b47d-4083dc600125",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8ef7d2cd-6f6b-4c60-9df1-638d41cdab9e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-16T22:42:23.9115966+00:00"
},
"company_sector_id": "b0223acb-10d5-4c1b-b5e5-33f942c0d1a6",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "619c179d-eff0-4e26-a67f-88fd241d2cd6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5700aaf9-1fee-48e6-8551-cdb78ae32d46",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cc0c4984-89b7-4712-a41b-93250e42e771",
"account_manager_user_code": "sample string 56",
"company_status_id": "6f352e42-eaa2-4410-9513-61f9ae261aa6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-16T22:42:23.9115966+00:00",
"id2": 60
},
"db_language_id": "bd3be463-680d-4d20-aa68-5697d54afee8",
"db_language_code": "sample string 7",
"db_title_id": "436d25bb-3668-4022-a77b-07ca9e71d542",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-16T22:42:23.9115966+00:00",
"create_date": "2025-09-16T22:42:23.9115966+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2025-09-16T22:42:23.9115966+00:00"
}