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": "8cd1e9ac-0302-4169-9a23-7ec58935495e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "68baa609-81ec-4444-9584-7965f8f779c3",
"company_code": "sample string 5",
"company": {
"id": "b7b08369-cb82-4d03-93bb-66e9709811ff",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-01T06:28:01.7797088+00:00",
"sales_territory_id": "7ed9dfb9-24db-48d1-9a22-7b43a0efa911",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ca6e199c-660b-42f5-8650-53ee15ffd64d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7f486691-c40b-4db8-b48c-d1ccf65cf01b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03341940-8d68-4cb0-a6ee-3c17e9eb5cec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b86c6d6f-6b3e-4d7e-972d-59ae504e5f52",
"db_currency_id": "58ef7c28-aab6-47e2-9b4b-0c45321cbacf",
"db_language_id": "2e01fc47-5be6-49aa-97cf-47fd83ccc14f",
"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-05-01T06:28:01.7797088+00:00"
},
"modified_dateutc": "2026-05-01T06:28:01.7797088+00:00"
},
"marketing_segment_id": "b788c379-c8a2-4adb-a8f2-320a36db29f0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "13c3b27d-a94b-4238-83c4-f6b02b9ec7b3",
"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": "203c12b6-6f80-48c3-818a-4c14bb159c4f",
"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": "df4fb57f-2327-438c-9ab3-12fb6c07b9ca",
"db_country_code": "sample string 28",
"feelist_id": "0650580e-02c1-43fd-ac3f-27b55cb6ee78",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "29502889-8d8a-4db4-93b6-145e1d3cac54",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bf241677-c235-45c3-bb32-0977a07188dd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-01T06:28:01.7797088+00:00",
"db_currency_id": "7e25e53c-9f4b-48a3-a1d0-1688ac0fed24",
"db_currency_code": "sample string 10"
},
"company_type_id": "adbefdf9-75af-4505-ac58-45e0e295531e",
"company_type_name": "sample string 32",
"company_type": {
"id": "f709e2cf-3064-48d1-9a8c-849dba58fd09",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "14e10ca3-8a47-455c-8017-68cfae2f1d43",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f7c395bb-911d-4f6f-ab0e-efa3269e5f9d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "62277920-c951-4ee8-ad15-1ffcf46c9152",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2450db9f-683d-4b52-8826-0b24d5d2b152",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "de6c9ec6-25f5-4555-9452-49fdbf042a4c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-01T06:28:01.7797088+00:00"
},
"company_sector_id": "5a9d699e-d422-44e6-8f39-d246c11438bc",
"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": "6868fa27-dd6f-479a-9314-39c290f45066",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "90271832-95d5-48a8-ab4d-91363bb16c11",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6164c85d-204b-444c-85d8-114c34d82fbb",
"account_manager_user_code": "sample string 56",
"company_status_id": "777553fe-75af-41cd-8dee-9bcf14b8d829",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-01T06:28:01.7797088+00:00",
"id2": 60
},
"db_language_id": "c0e372c2-2c6e-498b-b231-694ad8072f14",
"db_language_code": "sample string 7",
"db_title_id": "6ad6311d-7822-4fb3-b459-00c09d7ea2ef",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-01T06:28:01.7797088+00:00",
"create_date": "2026-05-01T06:28:01.7797088+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-05-01T06:28:01.7797088+00:00"
}