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": "b7c4f173-3f5a-4301-b9b8-c6203fa3602c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f3bfbf89-4c2e-44a3-8cc3-65c35fba54d8",
"company_code": "sample string 5",
"company": {
"id": "510046ff-5d41-4e5a-84f1-747a0fbf23e0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-29T18:42:31.5009335+00:00",
"sales_territory_id": "0e419006-6a74-41d3-b3a8-4fa55dccbcbc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "689bee6a-dc37-41f8-ac00-4c85e7b8e592",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "52393d83-9a6c-4f6f-85fe-fbebb14651fa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "72d2aa28-3c69-47c1-b737-53ffad6a5f77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "20a55352-65dd-454b-9759-a5f71c77796e",
"db_currency_id": "8d07deb2-e28a-4e5e-bc06-3dce2e26f9a4",
"db_language_id": "4498d9b8-37a4-4d73-9310-e4a2fb615d39",
"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-29T18:42:31.5009335+00:00"
},
"modified_dateutc": "2025-11-29T18:42:31.5009335+00:00"
},
"marketing_segment_id": "5028dfac-57e5-4e31-af62-fd236c8ec4d1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d3d79afc-8c0c-4561-af9b-f2361d816933",
"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": "fcf2defd-a99f-40e7-9a05-08ec132864e8",
"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": "0ad06276-6d54-4d76-a73d-912c477ebb8e",
"db_country_code": "sample string 28",
"feelist_id": "b6b289b7-5832-4e60-a0cd-9e44e459d62e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "45472d76-ecd9-4950-9c09-87ebc3facb7c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "17be447d-d04c-4dc6-bae3-9590489bab13",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-29T18:42:31.5009335+00:00",
"db_currency_id": "2654c08f-7c37-4186-ada9-2e1221433989",
"db_currency_code": "sample string 10"
},
"company_type_id": "9540760f-e38f-4e0b-98ae-48f616007818",
"company_type_name": "sample string 32",
"company_type": {
"id": "0706c5b5-2d6e-4808-ba0b-457fef546dc5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "53b78697-2e49-4887-983b-0eec9a7de30d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "98a15c65-5db0-43b2-98d6-d67a655573ce",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "800d5bd3-c39b-4893-8bcf-d7ba4e48db70",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5bfb5864-a524-4c69-8ab5-44d62160f7e9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "134c5419-5a69-4811-a1d7-f99f231cb248",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-29T18:42:31.5009335+00:00"
},
"company_sector_id": "2b44e4b5-a80f-4825-85c2-2fca8294eb14",
"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": "caa54c90-a892-47a0-b191-e9afdaf91509",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c67d3861-4ecf-47b8-a7a4-8a888803471b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f96abcb6-f088-45d3-b2d7-0e5cb8867e0b",
"account_manager_user_code": "sample string 56",
"company_status_id": "413e8925-aecb-454b-87b1-6a323cd69694",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-29T18:42:31.5009335+00:00",
"id2": 60
},
"db_language_id": "199dd6a1-ddf7-43c8-82fb-600cb948d85e",
"db_language_code": "sample string 7",
"db_title_id": "9500b009-055d-42c5-9efa-2655a0b15ff4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-29T18:42:31.5009335+00:00",
"create_date": "2025-11-29T18:42:31.5009335+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-29T18:42:31.5009335+00:00"
}