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": "3c9857d1-072a-44cd-9b2e-a1b1b22ad263",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5a05e16a-3e90-4514-b61b-3d51aeb477e8",
"company_code": "sample string 5",
"company": {
"id": "6178c064-5aeb-4631-8151-ce8cbc058103",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-18T22:03:42.9098166+00:00",
"sales_territory_id": "419cede3-b1a4-4bfd-94cf-a3b625f9c6a7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bcc7d880-8f94-48fb-b04d-78dc910f211c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6ec06488-2b77-4c72-8075-51223fd442ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d0cb96e-5d46-48e9-bf0e-afd7a6ac32b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f916dab3-060e-4239-af0e-d41021747b11",
"db_currency_id": "38f94c94-ba7e-4b91-bc88-1ff345ec6766",
"db_language_id": "5f7f1498-2302-4482-bb3d-2278b4451b93",
"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-11-18T22:03:42.9098166+00:00"
},
"modified_dateutc": "2025-11-18T22:03:42.9098166+00:00"
},
"marketing_segment_id": "a8260dee-ef36-45e9-8087-57f8672e922d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "376816df-568f-4274-856c-8fd08fbc5d7a",
"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": "202a6a7c-0610-49d3-876e-1d754899ebd8",
"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": "25a174d8-130b-4d41-864e-c97e2867e3c6",
"db_country_code": "sample string 28",
"feelist_id": "35851fd6-c38c-4bfb-a0d1-ee07e4ad2a09",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b93f94ed-fffe-404b-84c5-c30750939e7c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3d7f632d-e779-42ba-ab03-a7c1c5951352",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-18T22:03:42.9098166+00:00",
"db_currency_id": "15d79607-03b4-45ee-98af-b6438d8cc5da",
"db_currency_code": "sample string 10"
},
"company_type_id": "543b8817-01aa-455e-b1cb-9d253f1528dc",
"company_type_name": "sample string 32",
"company_type": {
"id": "e1bde733-7745-4e12-8320-91fd5a8f9d1e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57101beb-d063-4b3a-a758-a3ec264f0345",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5d8e004e-5c2a-4f11-b677-43f123e088c9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6599ace3-88d5-4b30-bfd1-c84d58ef25b4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "73250750-fcc1-4c34-9c32-9c9a7e1dba12",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3b0117cd-f710-4291-ae12-767f138177df",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-18T22:03:42.9098166+00:00"
},
"company_sector_id": "b9048851-c4ed-4658-8fa5-1088b2a83649",
"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": "a4744da0-e2d4-4444-8c20-665923ddd24e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9f57aaff-cfb6-4bc9-805f-c17c593a0712",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8c5587e5-432a-4efb-99a4-c763d1c4af06",
"account_manager_user_code": "sample string 56",
"company_status_id": "91096d6c-cc03-4b45-b3a3-0ae5228a1bd7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-18T22:03:42.9098166+00:00",
"id2": 60
},
"db_language_id": "e9b0c827-5e8b-4a2e-8ce3-267eb95e0613",
"db_language_code": "sample string 7",
"db_title_id": "56801335-0a07-4611-8ad6-1cae0e131160",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-18T22:03:42.9098166+00:00",
"create_date": "2025-11-18T22:03:42.9098166+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-11-18T22:03:42.9098166+00:00"
}