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": "c06928e0-19ec-435c-b74c-9902515db0c2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fcce1949-6246-4c32-9907-7949002101fa",
"company_code": "sample string 5",
"company": {
"id": "e694531a-5221-4a60-824f-3e94f79fd45c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-15T00:30:04.8180977+00:00",
"sales_territory_id": "dfa1f613-d82d-418f-8beb-4b8aa80e6238",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e405d534-d037-400e-a694-2f7aed1f6518",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a5181d50-83ab-4f46-96e5-6c1da435203c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cd866e82-e0f0-401e-96f2-56343aa162fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77dc14e3-ade9-4287-a846-06cdbf5f6df7",
"db_currency_id": "588eb6b8-7220-4260-a6fc-7e9ca52c8b44",
"db_language_id": "5d0fdf18-0606-4748-ab33-c1cc5880e00b",
"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-02-15T00:30:04.8180977+00:00"
},
"modified_dateutc": "2026-02-15T00:30:04.8180977+00:00"
},
"marketing_segment_id": "bf4d8678-c7e5-4eda-986d-cd46c65898b1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "00d139e9-9ba9-4038-a917-4dacf9ddcdfb",
"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": "ca1cea5b-f9ea-4de7-9f5c-a77283ceaf79",
"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": "cc4943bc-7d97-455c-b404-4db5bb89dd37",
"db_country_code": "sample string 28",
"feelist_id": "13f7ea97-c813-497a-9ee8-5dfb0912d03c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d5355a85-2f5c-459d-abd1-a6fcee716758",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b30d98c9-741a-4919-8a62-05cf0ef0ca0c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-15T00:30:04.8180977+00:00",
"db_currency_id": "bc8e30f7-266e-49b7-8a8f-77c87caa9400",
"db_currency_code": "sample string 10"
},
"company_type_id": "38675008-a907-4696-8a27-9c30271a276e",
"company_type_name": "sample string 32",
"company_type": {
"id": "d8842425-f69e-4463-88b6-36aea3f1090c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "54b0da88-fa6e-48b2-9cf0-add5fb4bfe4e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a624ba60-ba3a-404e-895b-7bd241e595c2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a642d229-0d8b-49d0-8ec8-672dc590b17c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3a283756-6a4a-4aca-9ff0-504b4d7a8a43",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b5cd9423-cc0c-40b9-af9d-0e2013ffc814",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-15T00:30:04.8180977+00:00"
},
"company_sector_id": "058c5fc8-9a18-4219-aeec-051e6176aca8",
"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": "19ffddc6-c00d-4c04-9c13-3a6691dbd8ea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "353203ba-d47b-4c3a-aad4-9490f35748cf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cb22b0a1-761c-4c6a-9aee-7ef93e60e31b",
"account_manager_user_code": "sample string 56",
"company_status_id": "7ca3d2f9-f09e-4e5a-b9bb-96f27e5d2cb4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-15T00:30:04.8180977+00:00",
"id2": 60
},
"db_language_id": "3cda41f0-2a43-4329-82ba-c5301aa11c02",
"db_language_code": "sample string 7",
"db_title_id": "8ce066e6-759d-4115-a8ad-5a772ad4ce6b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-15T00:30:04.8180977+00:00",
"create_date": "2026-02-15T00:30:04.8180977+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-02-15T00:30:04.8180977+00:00"
}