Retrieves all the company contact
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": "0a91ae68-b5fc-40d3-81d7-496ecd51419d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c8d9b448-d4c7-4b38-9e63-0a9d14fd2188",
"company_code": "sample string 5",
"company": {
"id": "207c5f0b-dbe7-4739-a20b-236b566c9698",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-07T13:35:03.3829316+00:00",
"sales_territory_id": "348ff8f3-dc31-497f-bba3-31f06087ba82",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "780a61cc-dcbb-411c-b8a0-75419037a58a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "19f7df3a-ffb0-4cfd-b67f-e53b3d83e3dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4592a79-8e77-4a8c-805d-bc7424a32650",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4a7121e-f0eb-4e70-ab62-aed9e7b33964",
"db_currency_id": "b3454526-fb1e-4d68-ac65-26ef748550fd",
"db_language_id": "dc5d286a-1192-47a8-b886-a6e212c3d3e4",
"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-08-07T13:35:03.3829316+00:00"
},
"modified_dateutc": "2026-08-07T13:35:03.3829316+00:00"
},
"marketing_segment_id": "15f44611-fe59-4c15-b05b-6e4d1ae894c2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "15cb00b5-cfb0-452c-95ec-2deadb72fe5a",
"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": "ef09e6d4-402d-4a6c-b924-f6a6ddd969cf",
"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": "2605e373-3a92-41df-8b02-a3bb488210ae",
"db_country_code": "sample string 28",
"feelist_id": "192adbe4-d31d-4b48-87d4-1bcd2ebed636",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f0deed92-73b5-462e-81b0-d60fc92c8af8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f6634c40-8a36-40f0-b22d-76ffa0ae6178",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-07T13:35:03.3829316+00:00",
"db_currency_id": "b07a315f-d3da-413a-ae0b-154a0eeceae9",
"db_currency_code": "sample string 10"
},
"company_type_id": "180c0ed8-c626-4941-8719-7f19076d3b6c",
"company_type_name": "sample string 32",
"company_type": {
"id": "493d9f0b-575a-4390-b6eb-137903b1c477",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "acf273cc-02f0-46e8-a0ce-58a72e4ad99c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b51a8f39-2bb4-46ad-be41-6f19616ec926",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "92dc5899-fcd5-4e38-936c-a5e8134b7bdc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "307f4aae-4e71-4f18-9147-d4e255126509",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "104c6707-3a5a-46ce-a8e5-ade02d6ca0fd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-07T13:35:03.3829316+00:00"
},
"company_sector_id": "8ba1e073-c8e2-420a-86aa-cfd7c389f9ae",
"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": "b7050748-1fdc-4d16-a4fc-fd8940da9c59",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "25cdbd2b-373e-4284-adc1-1eead801d35a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4c520fbf-e9d7-4732-a5f8-7cfc6014bbb1",
"account_manager_user_code": "sample string 56",
"company_status_id": "b06d740a-09c8-4400-addf-5ecb8b344452",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-07T13:35:03.3829316+00:00",
"id2": 60
},
"db_language_id": "49a57ba4-d482-493a-8223-e7ca82ec2c98",
"db_language_code": "sample string 7",
"db_title_id": "aa71f506-0351-41eb-9930-dcb77b9609a3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-07T13:35:03.3829316+00:00",
"create_date": "2026-08-07T13:35:03.3829316+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-08-07T13:35:03.3829316+00:00"
}