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": "16eded54-f6cf-4c9d-a57d-bc32d7ece3d8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "769cf710-8e5b-46b3-b7ed-f378fd150c22",
"company_code": "sample string 5",
"company": {
"id": "2198f3dd-e086-4289-8f71-dee4c580896c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-01T05:01:17.0647993+00:00",
"sales_territory_id": "b36107a6-bf79-4b22-bd51-5d90f19efbc0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "96ebab3d-e1f7-4bb1-b34b-a44470a8aace",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9d08e384-185d-489c-9f4d-89d6f8df9e94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "378ad01e-ade8-4344-a784-8970834a71a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6777ed8-1727-420f-aea5-2b8cc46d9fe5",
"db_currency_id": "2cb979a2-3e11-412a-a33d-e314611eed81",
"db_language_id": "fd561ac5-9b02-480c-8695-9c7b4acda27b",
"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-10-01T05:01:17.0647993+00:00"
},
"modified_dateutc": "2026-10-01T05:01:17.0788624+00:00"
},
"marketing_segment_id": "02cc17b6-2d7f-4740-98f0-9804dd5c5255",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "306e8eca-b0e6-44dc-881f-5b781119b461",
"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": "312d497d-ab9c-4dab-8054-8a2889286f22",
"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": "1bbc03a5-3d1f-47b1-8bac-6e8514e22308",
"db_country_code": "sample string 28",
"feelist_id": "4a7690b1-a120-4b6a-80e7-0b855ff612b9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4957bab9-9869-4051-9370-ff479c283765",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4772415d-9943-430d-b973-8ee9087f5373",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-01T05:01:17.0788624+00:00",
"db_currency_id": "d98bd207-ef5e-49c3-aff1-02d210c09698",
"db_currency_code": "sample string 10"
},
"company_type_id": "de7d42bc-8afb-4a58-b880-c34bb0edc2fe",
"company_type_name": "sample string 32",
"company_type": {
"id": "0e6089be-a45d-4fc8-8675-1bf68a729d41",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "08bc356e-2de9-4649-b0ba-00948addd571",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6de017ee-0f9a-4566-839c-9582240aabba",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "03f291e8-7c3a-4eda-b172-b98b09199c59",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4da40e13-3b98-4200-8b99-25f773edcb8a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "48177ed5-d990-41ab-83ce-1619551c378d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-01T05:01:17.0788624+00:00"
},
"company_sector_id": "9319e050-e7d4-444d-831b-182551f5503d",
"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": "da7c97e7-75b2-4c9b-b8cb-f0fffb756b41",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e8c88aee-b937-470d-bdad-073615bce28b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dcfd5c5e-3853-4e31-aff8-dbcee0e7aa55",
"account_manager_user_code": "sample string 56",
"company_status_id": "63f2de4e-10bf-48ef-acf8-0ff1042e2dac",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-01T05:01:17.0788624+00:00",
"id2": 60
},
"db_language_id": "c114dba1-360c-4d1c-85bd-a12d13be3db3",
"db_language_code": "sample string 7",
"db_title_id": "cbeeff62-599b-4d15-be94-3dc828001bc0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-01T05:01:17.0788624+00:00",
"create_date": "2026-10-01T05:01:17.0788624+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-10-01T05:01:17.0788624+00:00"
}