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": "77d873a0-5a9f-46a7-b15d-6ebd375ff776",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "df255473-0cbe-499c-9337-e7e005fb0969",
"company_code": "sample string 5",
"company": {
"id": "15265d60-cc04-49d1-bc93-9a2cb86f9523",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-18T00:31:33.9572467+00:00",
"sales_territory_id": "47020d71-e070-4b5d-914e-cd2f9b458af7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "97a479ba-4acb-4a06-8389-9f3c87bcb4d7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9b7b64e4-a59a-4173-861f-00cabe866ce4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c6d6317e-f774-44c6-85a7-cf24c378bbd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f9c5fe-95bb-40f1-ad67-72004180669f",
"db_currency_id": "55128794-f50e-4df0-bad5-0355742d3631",
"db_language_id": "a0d8a789-3a67-4ccf-ad4c-6cc900f5fa5c",
"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-07-18T00:31:33.9572467+00:00"
},
"modified_dateutc": "2026-07-18T00:31:33.9572467+00:00"
},
"marketing_segment_id": "f376a05f-23d1-4320-b881-e307e34f2a3e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ad3a5eef-8c84-4e81-8b0e-b1efad1c02a9",
"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": "b415a485-28d1-49eb-b679-4a0bbf736823",
"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": "8f4edc3a-4e71-44a1-a7ae-70d7da80be2a",
"db_country_code": "sample string 28",
"feelist_id": "a83f8342-3777-4ff6-81a2-e70db38c3bf2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6c32dbd9-4452-4c2d-aadf-c8d6829d7cab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "139c5c95-bbe4-4f21-bf4a-f729adb85018",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-18T00:31:33.9572467+00:00",
"db_currency_id": "685d7bac-49c8-4541-9484-1b0412ea673d",
"db_currency_code": "sample string 10"
},
"company_type_id": "48c9e6b2-437f-4f52-91d0-76dcacbb2d47",
"company_type_name": "sample string 32",
"company_type": {
"id": "ccc9aca5-509b-47a5-86bb-e2cb5e083c17",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6d2e9c76-24fd-4481-b7b6-288c77720f4e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1ea9c636-3aa7-40e5-b042-21fece64b16b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a65c6bdf-c060-450c-84e3-a96c951bcfbe",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "99154be4-6cf4-4088-a24f-04465fdb93a4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dd310384-8994-45d2-9c01-7266e3fcfc40",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-18T00:31:33.9572467+00:00"
},
"company_sector_id": "9018ce56-4b39-4c4d-a418-4ef59639e523",
"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": "44eb3029-608b-4aa8-9577-4f8cd5f5fa54",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "74ef185a-41b5-4595-bb0e-2009ba629ed3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ec7a11f6-f3b0-4f37-9c89-df0211f28274",
"account_manager_user_code": "sample string 56",
"company_status_id": "7895fa8b-984d-47ee-b015-2eab67b4074f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-18T00:31:33.9572467+00:00",
"id2": 60
},
"db_language_id": "f665b662-d4fc-4087-a811-b3ab319d2a8b",
"db_language_code": "sample string 7",
"db_title_id": "705fd4eb-3f32-4bfd-b3cc-63b8c94a3221",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-18T00:31:33.9572467+00:00",
"create_date": "2026-07-18T00:31:33.9572467+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-07-18T00:31:33.9572467+00:00"
}