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": "947858ca-f8f4-414e-a2e6-4eba82c513c1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cf39216f-d082-44d8-b302-62d312c66b07",
"company_code": "sample string 5",
"company": {
"id": "cc7e73df-153a-42b3-9b3c-fc33268649a2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-21T16:10:44.1396302+00:00",
"sales_territory_id": "3a5e6a0a-b9dc-45c0-83a4-c71a95b33406",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4f139182-9119-4a2d-b7d7-b4c45fed3b8e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b59471be-531a-47af-894c-64dc4add2d29",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed08bda1-efbb-451f-bba9-f7be64c783e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "55fe79f7-ce83-41f8-a1a2-84621672bb8b",
"db_currency_id": "4adac2c1-4570-4374-9f71-b579e31b25e5",
"db_language_id": "638c5e32-a4bc-473b-a78b-c2d6997a6fb0",
"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-21T16:10:44.1396302+00:00"
},
"modified_dateutc": "2025-12-21T16:10:44.1396302+00:00"
},
"marketing_segment_id": "a204e919-b570-4dae-9973-e580887ad190",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "02186be3-d11e-4624-9439-1dde8a4c2fe0",
"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": "2456b522-7798-4c2c-bb47-34adb97f35f7",
"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": "05ccec0f-3f6f-4093-9aa5-14d86b854608",
"db_country_code": "sample string 28",
"feelist_id": "4a3ee487-8c10-4eb9-b575-1b0a49cc5695",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8a140476-4096-4ea8-a334-bb568e2b9ddc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "99c5a6d4-7c04-409b-a112-cfca45a712be",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-21T16:10:44.1396302+00:00",
"db_currency_id": "938febe3-970b-44a8-92d1-b070e88feb75",
"db_currency_code": "sample string 10"
},
"company_type_id": "8a241205-b1fe-4fd3-a1ce-95d37eefa21b",
"company_type_name": "sample string 32",
"company_type": {
"id": "f12f45ed-c3a4-4757-be4c-f36d38396a67",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a72f1bb4-c954-4c8e-90a4-90e23adeec7c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1f19cc6c-8862-4caa-b280-09ff09ac3d9d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4d16f47c-f33a-4d1b-83fc-73e9f92fb352",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "14bacf4e-692e-4f6a-9714-f87b1f5241bb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "90f57a7f-0ce8-48f0-8973-7d9f8f4a56ab",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-21T16:10:44.1396302+00:00"
},
"company_sector_id": "c487eeb6-66fa-4c3c-8fdc-9f4bebd7b367",
"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": "5fe39a1a-acd7-4c27-9d5b-97f15c4b6fda",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0a24a0bd-fdf3-43ee-af1f-b089e2c0a03f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "44976ae3-2144-4bfd-8589-f8b36b2d5eef",
"account_manager_user_code": "sample string 56",
"company_status_id": "d00ce0b2-314b-438c-bbb4-12023eac8d76",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-21T16:10:44.1396302+00:00",
"id2": 60
},
"db_language_id": "966f15c5-01ea-496b-ab3a-4e653dd459dd",
"db_language_code": "sample string 7",
"db_title_id": "f813daa9-69cc-43fc-83be-459b229da749",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-21T16:10:44.1396302+00:00",
"create_date": "2025-12-21T16:10:44.1396302+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-21T16:10:44.1396302+00:00"
}