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": "fc58dc3c-a223-471b-b415-8a4f1d3a55c5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c0ed15d1-1360-4852-9775-88c834df4279",
"company_code": "sample string 5",
"company": {
"id": "2e91a59d-e0c8-4918-bba4-6110ce281c50",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-27T16:36:49.7801429+00:00",
"sales_territory_id": "a1ca1456-b6ba-40e7-a578-98ca5adf5076",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5c23fe96-1b87-4892-aaac-0857acb37f60",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "72a35e76-51db-48b8-ac18-8c0cf8f6371d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "97e2a448-3908-492f-aa1a-e6891dcd64ff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01b0a779-6d1f-4fd6-b32e-44d2137371c4",
"db_currency_id": "869bafff-e6b8-4064-99d3-fe516c62ea15",
"db_language_id": "cb2e7f25-96b2-4710-9922-38b6a55334a7",
"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-06-27T16:36:49.7801429+00:00"
},
"modified_dateutc": "2025-06-27T16:36:49.7801429+00:00"
},
"marketing_segment_id": "f5394b78-d2da-43b2-9a4c-533b554f0963",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7b7e26dd-0d62-4977-9a64-f14c840f5ede",
"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": "df8b28a8-82a0-4478-af9f-550ea4077fe9",
"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": "fc52d0ae-62bf-40e4-9702-5260b4acac56",
"db_country_code": "sample string 28",
"feelist_id": "ee502d5f-8782-4a48-a253-74c227134942",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c0c5f4a2-e326-48ae-aa04-f69cd278d5cd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b34ace13-5ba6-49b4-a09d-aaf02a69e251",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-27T16:36:49.7801429+00:00",
"db_currency_id": "e2fc3bec-219a-4f0d-a212-f76df66edc9c",
"db_currency_code": "sample string 10"
},
"company_type_id": "65dbe048-482e-4056-a520-471385df4c0f",
"company_type_name": "sample string 32",
"company_type": {
"id": "6114536e-1fc3-42e4-a4f2-e42f07369615",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "16730d9c-16c8-44a3-a962-f99cf5a199a1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b4b304d6-2e12-4b7c-835c-3bc5f25401bb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a9c49412-8927-42a9-bcce-5f2acb6bd65a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c7b54e2e-b1ae-4d2e-a531-354338d0e46e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "64829451-cadf-40b6-bf94-2d03e1521064",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-27T16:36:49.7801429+00:00"
},
"company_sector_id": "38a2a185-38b5-44df-9570-9abc90c1be2c",
"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": "f3b9dd37-7cc3-48ec-a9a1-b485793ffeb4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2ee2ebc5-6307-471a-ae67-896a71ae9076",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e2319bc9-0477-4682-a8da-fe194dcc46c4",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3dec02e-2a6f-4ea3-81d1-85b2f6e80d76",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-27T16:36:49.7801429+00:00",
"id2": 60
},
"db_language_id": "32ccbdf5-d6cd-4265-be4e-807e006affea",
"db_language_code": "sample string 7",
"db_title_id": "ffaf98b9-a9d3-4333-9a73-17e7cbb9e2f4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-27T16:36:49.7801429+00:00",
"create_date": "2025-06-27T16:36:49.7801429+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-06-27T16:36:49.7801429+00:00"
}