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": "b81fbc87-cea3-4725-97e3-333994f942ed",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8f5fc64e-4d52-45b6-ba98-bb6e5d274607",
"company_code": "sample string 5",
"company": {
"id": "2a610ec7-22ea-487a-9c04-301d21ea07f7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-23T08:48:37.9856093+00:00",
"sales_territory_id": "f5618438-1257-43db-85c7-3f959dfb9252",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6f582bbf-bc53-4f31-815d-d14cbde4fc25",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "306416a2-48bc-475d-90d7-d0ad2a18fa1e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "714ef684-45c6-4a70-aa6d-89f038d84849",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6af3f4c7-403e-4f72-915c-c3a28618ac17",
"db_currency_id": "2f721489-13ed-495c-8019-d98b6d489f63",
"db_language_id": "5c60b013-9a08-4720-a6b7-16adf05df344",
"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": "2026-09-23T08:48:37.9856093+00:00"
},
"modified_dateutc": "2026-09-23T08:48:37.9856093+00:00"
},
"marketing_segment_id": "cc2f7541-4f95-425e-9975-090b58e38f90",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f0dbf02e-7bdc-46e9-bab1-b46cf49ac937",
"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": "0da367d8-7875-4c8b-9e6d-32cbc063a54b",
"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": "3369e02a-3da6-4f7e-9e62-fa43b119af87",
"db_country_code": "sample string 28",
"feelist_id": "8622d8cd-5d3d-4357-9348-08fa8d69b5fc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "27eff58d-0ae6-4d0e-b4b3-f51ec4c79cd4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "679c0c4b-42ef-42d4-9a78-7c717908b6f9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-23T08:48:37.9856093+00:00",
"db_currency_id": "8dd01804-cd77-49f3-bf3e-6a93b39b5cf8",
"db_currency_code": "sample string 10"
},
"company_type_id": "e42f4433-274e-4025-9323-ca98f24d3674",
"company_type_name": "sample string 32",
"company_type": {
"id": "22de3467-cbd0-4cfe-8805-431e460951f0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e093d64-982c-4dc5-85ee-083d8e19a647",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7d3a0cbb-5b7d-4198-b37d-110e0ff46750",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "01896ca5-33f9-41b0-9cb9-431077e88dce",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bdde412a-1e30-4931-b9a6-04f6b995a88b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9851e443-1eea-480a-b0d6-0b7bdc554319",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-23T08:48:37.9856093+00:00"
},
"company_sector_id": "37ac4663-320f-423d-bb4e-1484585ac925",
"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": "bf95fb8b-3d3f-440d-bfcc-3df7a572a22d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d8a599ae-cee8-456b-a5d4-0aca3707abc3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f831820f-247d-4d27-b46d-8e4e5c52a67f",
"account_manager_user_code": "sample string 56",
"company_status_id": "04bacffb-15fa-4e29-9c14-b44a5a2ec716",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-23T08:48:37.9856093+00:00",
"id2": 60
},
"db_language_id": "dacffbb0-82ed-424b-ac5c-a9a6014dbe96",
"db_language_code": "sample string 7",
"db_title_id": "5e043581-4de8-4aa0-aa07-971dbfe9d75c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-23T08:48:37.9856093+00:00",
"create_date": "2026-09-23T08:48:37.9856093+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": "2026-09-23T08:48:37.9856093+00:00"
}