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": "7df19361-e44a-4087-8b6e-6650bc000577",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "78e8c0d7-cb40-4beb-b5fc-39a504dfc2e1",
"company_code": "sample string 5",
"company": {
"id": "8645695a-9174-4ad2-9647-75c6442a5cde",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-25T22:08:02.0463318+00:00",
"sales_territory_id": "282cd9ea-d6d5-471c-84e0-24b8596df984",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "85a318bd-e636-47f6-bc6a-1c1135fa051c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42bcb530-ecbb-460d-be44-f375746fa1d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bfb6fe0e-15de-4533-bf79-eac4dc232b5b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ae7a733d-82e5-4aea-a080-c29053a699f0",
"db_currency_id": "b56a84ab-2d90-4416-9649-4db97106f854",
"db_language_id": "c6786781-d340-45e8-a225-5e06e9af4d2a",
"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-12-25T22:08:02.0463318+00:00"
},
"modified_dateutc": "2025-12-25T22:08:02.0463318+00:00"
},
"marketing_segment_id": "c7ed8b73-4260-46f4-a295-2f16f46d0c09",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bf3d60f5-18ca-47b6-b5bc-bcd482ef94a7",
"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": "c2117c87-7a9d-40f0-8899-b966d1426995",
"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": "5644b06c-1139-40cc-a6dc-d1f7ee4a2ae3",
"db_country_code": "sample string 28",
"feelist_id": "2bc9030f-5c52-477f-9b9d-e30ff6984145",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fbb9dc2e-be6d-4afd-9322-081ba5adfc46",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "feecc50c-6ca8-4915-82aa-3cff3b4acd05",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-25T22:08:02.0463318+00:00",
"db_currency_id": "2849c860-664b-4768-91f8-d88f5aa5a392",
"db_currency_code": "sample string 10"
},
"company_type_id": "dc552d0f-eeb6-405b-ac68-8e9766243826",
"company_type_name": "sample string 32",
"company_type": {
"id": "e481f4ab-2bc0-4c16-b2f7-eeb19ec11716",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ac63f758-b52e-4a5c-871d-f5ea1f247844",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fffc2d83-910f-42b7-9d1e-5d193c7f49eb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "45e15b96-9ea7-4c9f-8f23-137dbac915a6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c9ec2e40-f525-4668-8647-1ef6518c7cbb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0444ac8d-8e97-4b5e-97fc-441da7ea52dd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-25T22:08:02.0463318+00:00"
},
"company_sector_id": "2f6faf46-8b69-42b9-a3c7-cae4b199e5a0",
"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": "e11cd2ae-1d32-42cd-ab7e-e83fa93ee9b2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "07968ba9-62a1-427a-a02c-fac1b32db091",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3d213927-256f-4d72-929e-79a88ee410e8",
"account_manager_user_code": "sample string 56",
"company_status_id": "2f9b516a-4b6a-4fec-8726-c48512c523fa",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-25T22:08:02.0463318+00:00",
"id2": 60
},
"db_language_id": "17c7bab1-2229-4e92-b098-7e97ddca1b3f",
"db_language_code": "sample string 7",
"db_title_id": "ac1beec8-9764-4f73-a7fd-047f14d66ea9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-25T22:08:02.0463318+00:00",
"create_date": "2025-12-25T22:08:02.0463318+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-12-25T22:08:02.0463318+00:00"
}