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": "1dca8a80-2818-40f0-84a8-1b31eda40e42",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "818ebb32-78b7-4aef-967e-5b92c82f30c4",
"company_code": "sample string 5",
"company": {
"id": "8dcf06f9-daf6-4338-ae5e-8a714d6e7737",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-03T04:10:15.9297736+00:00",
"sales_territory_id": "49bc2db0-9812-4d02-b903-af5d5ac81029",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "03f8c48b-065f-4742-84f7-f3ae35be8011",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ef16511-64a7-46c4-b2e3-458583a0066f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2374b749-a075-4f38-9b26-b4d255e46b25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4f57d1b-cb46-43b4-97ce-bd05f760c9c0",
"db_currency_id": "48269c48-4424-4940-aca2-5a92b1907721",
"db_language_id": "a1093cde-b86b-4a71-96a8-8f2eae8d92d7",
"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-03T04:10:15.9297736+00:00"
},
"modified_dateutc": "2026-02-03T04:10:15.9297736+00:00"
},
"marketing_segment_id": "04aa3f8c-2016-44e9-bb54-26d0979695ff",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "296eab24-66f8-4dba-af74-bf7436217dde",
"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": "b95bd30f-dbc1-4dd1-b498-e75bd7fc17f9",
"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": "6c042314-411e-48eb-93c7-084a8071290c",
"db_country_code": "sample string 28",
"feelist_id": "fbfdbb2a-af7f-4f52-a8bf-ce6278a0e267",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e1f6c03a-5c20-4f77-8f0c-a885761edb51",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9dec8c6b-b56f-40e1-9992-cd2483cc44a4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-03T04:10:15.9297736+00:00",
"db_currency_id": "0a43fc9d-674f-4e93-b04f-84a429e5222b",
"db_currency_code": "sample string 10"
},
"company_type_id": "ef099761-506c-456b-af41-6a28ea2ee45b",
"company_type_name": "sample string 32",
"company_type": {
"id": "dfa8b545-19c2-41b7-9130-3bfac7d6a782",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "76cc2bc7-ec45-4ee4-9137-2bfd14ccda4b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "338526c4-b8d4-4a12-9e0d-f4e4370b882d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "37e721ce-c8d1-48b0-89ce-0b80f0c3db22",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "94bab771-781c-4bff-9529-7277954396c2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a89427a1-5184-411d-9872-1cbba07ab217",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-03T04:10:15.9297736+00:00"
},
"company_sector_id": "f95ed7d7-2276-407a-8a65-edf32e18c696",
"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": "f7c5c4b6-eaf0-4771-90c9-4f4247a93689",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d45d0fa3-58f3-4b08-a473-3f4aa4c292e3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2449b77c-ee7f-4ece-b6d4-f58248fa7560",
"account_manager_user_code": "sample string 56",
"company_status_id": "a2521513-f67a-400e-bb34-8d00e9f178ff",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-03T04:10:15.9297736+00:00",
"id2": 60
},
"db_language_id": "85653afb-d04b-460b-9386-869e3ddf8d3b",
"db_language_code": "sample string 7",
"db_title_id": "0c97be6c-13bf-4471-b6f9-174f53aba07f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-03T04:10:15.9297736+00:00",
"create_date": "2026-02-03T04:10:15.9297736+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-03T04:10:15.9297736+00:00"
}