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": "a109ed9a-dd13-4ab0-a322-bfe4e75e8c21",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4a43aed7-6900-4746-abde-c9a9626d4a3f",
"company_code": "sample string 5",
"company": {
"id": "0bac9e69-e3e5-4673-8702-00c0c6a3f433",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-02T04:56:30.2947334+00:00",
"sales_territory_id": "c75e68d5-a21d-48bf-8674-2b0be48a2590",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5dd094d2-a2ba-4077-8756-2a2e1ecfa6c0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "26cbd36e-e1cf-4def-9086-969fb753f8f9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3e0bab5c-91e6-42cb-81d3-16cdad0cca4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5de88220-09eb-4635-8faa-5f353633e90e",
"db_currency_id": "fd2d6936-9948-4b7f-b704-1e2c89d5f218",
"db_language_id": "0225d702-dd53-4475-9255-5896ee8a6016",
"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": "2026-11-02T04:56:30.2947334+00:00"
},
"modified_dateutc": "2026-11-02T04:56:30.2947334+00:00"
},
"marketing_segment_id": "4a91d261-48d9-4bcc-956d-162f9d3686ea",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bac80ac5-b87e-46ea-b09c-1793d56ffac5",
"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": "334f17ec-f5b3-4b09-bfb3-39f8283a0ed3",
"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": "1e5a87d5-0c8c-4b4f-8a5e-f465caccc893",
"db_country_code": "sample string 28",
"feelist_id": "8e23e938-ec6a-48ae-a6f1-8fcdf285c318",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1caf851e-fdad-4675-8e36-333bea41a357",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3d7aa490-cf74-44a5-a9c1-b8deac42ef43",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-02T04:56:30.2947334+00:00",
"db_currency_id": "84264862-4cce-4770-9ee4-6e6e3ce1d177",
"db_currency_code": "sample string 10"
},
"company_type_id": "a60e82ac-8281-4fb4-930c-bd8dbcc75b67",
"company_type_name": "sample string 32",
"company_type": {
"id": "3a066742-64e3-4831-a547-8a49d8e5f43c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7630e7ba-f3c9-4e5b-b9c7-6834c8f5097c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d93c1dce-b5e8-4337-bf68-fac1329ed07a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bffd436d-5c1d-4bad-8fd2-a1a34f9596db",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "263dd3df-ce3f-4eb8-bb50-3f0ec608e558",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8c40c575-b008-4b7e-98a3-1199c1e10f5d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-02T04:56:30.2947334+00:00"
},
"company_sector_id": "05ef0fc9-d2e6-4327-9cad-f1fcea64ee81",
"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": "7c3a421d-77fc-4db4-8b25-d08c07bfb070",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "add1d413-89e9-4b47-ab3f-a72c1935d1ae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "222baac5-9aea-439e-a43e-9ea2c13e44ff",
"account_manager_user_code": "sample string 56",
"company_status_id": "33c0cddf-821d-47cf-b06c-79fc3dbebc0b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-02T04:56:30.2947334+00:00",
"id2": 60
},
"db_language_id": "db3695ac-7890-4811-851e-e522d0e00cc2",
"db_language_code": "sample string 7",
"db_title_id": "a87e0827-3216-40ca-8761-6d629d10b07f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-02T04:56:30.2947334+00:00",
"create_date": "2026-11-02T04:56:30.2947334+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": "2026-11-02T04:56:30.2947334+00:00"
}