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": "7c15403f-03b5-4198-af68-d8a10663fdc0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "003b2b0b-76ec-4a7d-b7f9-67df33643337",
"company_code": "sample string 5",
"company": {
"id": "471d787e-f465-459c-9e03-d59aef3da692",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-20T12:07:45.9634757+00:00",
"sales_territory_id": "1bf35ed5-8ed8-4c02-8832-d422960e04c5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10d517ff-363c-4f67-9caf-78b683ef77ed",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2cd72b05-a77c-48ec-b73a-f182d453b4f1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2a8ed1f9-64d4-41f8-9bb3-e6028d494fb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e7b81e7-130b-4a07-891b-88f57d7c542c",
"db_currency_id": "87fc256b-ec1f-4db6-a164-5068a19f6bdb",
"db_language_id": "d0b4e499-14ec-4d5d-b0d8-b98bdac19d71",
"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-12-20T12:07:45.9634757+00:00"
},
"modified_dateutc": "2025-12-20T12:07:45.9634757+00:00"
},
"marketing_segment_id": "7c3488e7-6ba3-4e46-ad7e-94e4234a48f0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "35dd4efe-8a51-4cb4-90f5-68f3888d0e27",
"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": "bb521ab7-1208-4bfd-88f4-d6d4a8632bcf",
"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": "1976972a-d4df-40db-99af-9042910ff941",
"db_country_code": "sample string 28",
"feelist_id": "ef0c7f98-0b92-4dc4-9713-c873dbfc2c09",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "35d04f8b-ec18-4222-8751-870eff2d5221",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e6d963e2-1675-4176-98c6-7c737b2adac4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-20T12:07:45.9634757+00:00",
"db_currency_id": "b9393565-c953-4182-ad1d-b312446802b5",
"db_currency_code": "sample string 10"
},
"company_type_id": "cb0e075e-f6f0-4edf-a057-c4915b1ed4ed",
"company_type_name": "sample string 32",
"company_type": {
"id": "ab0f3c80-e82c-4ebe-ad4d-0691569eb768",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd2bcf9d-521a-4d36-8294-63acb24ba5c7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1a06bfd7-2c85-48fe-9b8a-523f9720b79e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e6dfdd63-73ec-4bed-96f2-2140a715992e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a706b3f5-544d-4411-ae33-ead6c44d2577",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "41028997-b742-48a1-84a6-b6d2dc1b638b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-20T12:07:45.9634757+00:00"
},
"company_sector_id": "8e9cd114-5bd6-466f-9443-4843b7de89da",
"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": "14ad9d9a-1cb1-437d-b318-890116d459d6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "71e885f9-be3a-42bf-bf2e-e4a7ec5a4159",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "654ae139-7a73-4a62-97f1-4afa08385968",
"account_manager_user_code": "sample string 56",
"company_status_id": "5b8c1d88-2c6d-49bc-b252-c1565bea2e47",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-20T12:07:45.9634757+00:00",
"id2": 60
},
"db_language_id": "2764ae52-09cf-4069-9b68-a8d15caffb02",
"db_language_code": "sample string 7",
"db_title_id": "3e39dc77-849a-4350-8ffd-c7895a254866",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-20T12:07:45.9634757+00:00",
"create_date": "2025-12-20T12:07:45.9634757+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-12-20T12:07:45.9634757+00:00"
}