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": "4d91dc5d-2b90-48e7-9dc3-1c43b3455aaa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc808ad6-d2f2-48aa-a939-7a3cc8ceafa8",
"company_code": "sample string 5",
"company": {
"id": "f22905ed-d4a1-4179-a7cc-a61c9a4c64f1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-17T22:40:19.3116281+00:00",
"sales_territory_id": "c4205079-1b4a-4b0e-86e9-39600efc7e74",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "09fec79d-06c5-45ec-aa7b-ab934f116f51",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e3b5d839-0b65-4fc8-8f13-26f54dbe402f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c71831f8-8137-432c-b88f-d7aeb625768c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c59d2052-c754-4724-bf47-993cfa43329d",
"db_currency_id": "3d6f8a35-10ca-43c8-9fac-da0e7d8054d8",
"db_language_id": "d852fcde-b91a-4f5d-82a0-3b40c6c58040",
"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": "2025-09-17T22:40:19.3116281+00:00"
},
"modified_dateutc": "2025-09-17T22:40:19.3116281+00:00"
},
"marketing_segment_id": "98c78458-a682-469e-8f82-87eade5e4926",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b45317d7-d6c0-452f-8e8c-df3503ad619b",
"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": "a2edf959-ce0e-48cc-8fed-843fa352216d",
"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": "bf6a7553-be21-45ce-b8be-1fe99dae4947",
"db_country_code": "sample string 28",
"feelist_id": "a31a7fa8-0938-4989-ad0f-2f985684a1ba",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "126538d1-ad71-48c4-9404-ce3b004590d8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5251beeb-5458-46c8-9c26-d430327abd7f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-17T22:40:19.3116281+00:00",
"db_currency_id": "4955fcd0-4b80-411c-9c89-d8d16e10a10b",
"db_currency_code": "sample string 10"
},
"company_type_id": "52dc8e74-700e-43a2-86d3-a56a7da5473e",
"company_type_name": "sample string 32",
"company_type": {
"id": "275d59a9-d8f8-496e-86e5-422a1ba72823",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a650e5c4-d0d0-46b8-b523-50d83d04d60f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "74be55a5-308d-4189-9cb6-65e0523618a5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c76afa1b-65b6-46ed-836c-4e018cde9d9d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6e4c72eb-09ae-4043-adbe-5d1ac493d2aa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "335efacd-1d51-41ab-8a24-b08d96dc031b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-17T22:40:19.3116281+00:00"
},
"company_sector_id": "35082d87-18b2-4cda-9d1e-65d5bb14c1c0",
"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": "21813678-7c74-48d8-91c8-60e3290925d9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9dd63133-bce3-4174-b253-412a65010c3b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "df4d4ce7-1be5-4a1f-a373-67feb123da32",
"account_manager_user_code": "sample string 56",
"company_status_id": "55734d9d-0fad-488e-81cf-f224556d3860",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-17T22:40:19.3116281+00:00",
"id2": 60
},
"db_language_id": "7e01d7eb-393a-4800-8ba1-6542ed5de181",
"db_language_code": "sample string 7",
"db_title_id": "96337a04-ef92-443d-9fd8-e9f0e7eae501",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-17T22:40:19.3116281+00:00",
"create_date": "2025-09-17T22:40:19.3116281+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": "2025-09-17T22:40:19.3116281+00:00"
}