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": "df89df1f-7c68-4f41-9bab-47fe9d3fb4ec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e1ae564d-5971-41cd-a79a-612b97f0b354",
"company_code": "sample string 5",
"company": {
"id": "289cba23-6253-4ad1-9b27-4e847d1e2567",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-08T21:46:01.2567221+00:00",
"sales_territory_id": "7bbbee28-c92a-4cfe-a798-35250d59afde",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1d9f81b5-3ac6-4e4c-b143-ccd0f9dc8ce1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04298a2f-090f-487b-9e3f-ccd8344b3aeb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9208dfb-423a-470d-a8cc-ccb75a10f05c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdc04e49-39a7-4589-bb9b-4faa835437b2",
"db_currency_id": "5478d3f4-efae-4b3e-8e16-5e6a87f0086c",
"db_language_id": "ffae5090-39f8-4561-a41e-645efd02fa3b",
"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-01-08T21:46:01.2567221+00:00"
},
"modified_dateutc": "2026-01-08T21:46:01.2567221+00:00"
},
"marketing_segment_id": "fe8ee24d-41d4-4685-b51c-eb0ff7562112",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4b1f8b16-9006-4827-bfdf-7b378396370e",
"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": "dec084cf-7318-47e1-988a-a7fc8953a224",
"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": "cf34d857-b898-4450-84bd-78f289be3f95",
"db_country_code": "sample string 28",
"feelist_id": "b1f87e9f-c2ed-47c5-b7d5-cd793822233e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "68a89eee-4248-4cb5-bce0-6ec536b5a798",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2945a112-8547-498a-ace3-f9c813feaf03",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-08T21:46:01.2567221+00:00",
"db_currency_id": "cd37902e-8f09-4c70-b989-ab437136c892",
"db_currency_code": "sample string 10"
},
"company_type_id": "89890df3-a2da-467b-91ae-caf7cc346909",
"company_type_name": "sample string 32",
"company_type": {
"id": "b56958fd-38d1-47bf-b057-88b40efb4de5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ba218655-9f97-47ca-9b4e-70673de4f98c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "90ad15fb-a15c-486d-ac6c-ce76548d7a82",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0c67e51c-b460-4caf-aff3-58517bf80ae3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8b13a475-fc69-4c64-af09-dbd3a29aecb7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "93fe7c39-c3bb-473e-b6ba-a041fdd8917d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-08T21:46:01.2567221+00:00"
},
"company_sector_id": "80d8d90e-0490-40bd-98f6-942877712474",
"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": "bf4c3882-76c2-4143-b5f0-71c864714e90",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "88e05a0f-dfc3-4261-aeb5-52e7e35accbf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9d23f553-dfbd-4115-bc7a-86fbd882a3a0",
"account_manager_user_code": "sample string 56",
"company_status_id": "65d7f973-a12a-4bf7-9c12-7545a786e556",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-08T21:46:01.2567221+00:00",
"id2": 60
},
"db_language_id": "140bdef4-7558-453a-9553-325355fd6704",
"db_language_code": "sample string 7",
"db_title_id": "32ede22c-6c8a-4fcd-8afe-a1ccb5109f8c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-08T21:46:01.2567221+00:00",
"create_date": "2026-01-08T21:46:01.2567221+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-01-08T21:46:01.2567221+00:00"
}