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": "b29426a6-a05d-42e9-99da-1c3a15141e2c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0b7fb525-6de3-42ee-a43b-517f4b7bd97b",
"company_code": "sample string 5",
"company": {
"id": "1f4f973b-07c4-4d6d-b4f4-e26c4db41e68",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-22T04:06:36.107402+00:00",
"sales_territory_id": "d0f64eac-0148-4bd5-869b-fb9f215fe5f0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "02ba5831-f83c-4a27-9a51-8d7ff5ce2d37",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7aef07bb-2ed1-453c-8276-e76f1709941d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "89248689-3aa0-491c-a55d-fd92e27a740f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9e1129e-2c97-4176-a299-fcf41d5d0353",
"db_currency_id": "fc91dd56-2ece-47d1-be3e-9e50b421d1d0",
"db_language_id": "d37670b0-484e-4279-bffe-55c91f83d117",
"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-22T04:06:36.107402+00:00"
},
"modified_dateutc": "2026-09-22T04:06:36.107402+00:00"
},
"marketing_segment_id": "af44e100-a59a-4a2e-9de8-609e80d1de78",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9426fbd7-3a14-47a8-a23b-5a063c00c775",
"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": "d27fa71c-2b07-42a8-a711-de03e6208d69",
"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": "fcdbc4e4-5f52-496b-8a54-c1a508e5f664",
"db_country_code": "sample string 28",
"feelist_id": "c0500976-6ee2-4ba5-b3f4-d0fab6f1d437",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1091bdec-c745-4e58-9d4a-aa086ff76b30",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "36dace44-28a0-40f1-b1a9-2eb1ac097bac",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-22T04:06:36.107402+00:00",
"db_currency_id": "f9f09434-c718-4e0e-a460-e99e894fca32",
"db_currency_code": "sample string 10"
},
"company_type_id": "bdf88662-027f-4cce-bcd1-2864ec036370",
"company_type_name": "sample string 32",
"company_type": {
"id": "f2c55160-62d1-473d-9f1d-c8523aab85df",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e38530dc-5615-4e92-bdac-a002754ddf5d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1b4c8b1e-a02c-4b5d-ac27-4df771d33e01",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d6df73ac-a01b-4256-9edb-733550f14bca",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4be5a21c-aa6c-4db5-88a7-477fcb461a1a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f1a13d18-32bd-4cbe-b858-6fe6c3b95eae",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-22T04:06:36.107402+00:00"
},
"company_sector_id": "f118188a-e50b-4161-a0d3-15eea5ff8ba8",
"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": "49fa410a-e3e4-43f5-801f-124159862b3a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cba247f2-bae5-4007-9271-0afced518c7a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bd92ccec-8fa9-447f-a140-49775bd6a779",
"account_manager_user_code": "sample string 56",
"company_status_id": "c6f15d76-c973-4178-af67-3aa95ea3e9fe",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-22T04:06:36.107402+00:00",
"id2": 60
},
"db_language_id": "4b392ea4-4d8c-4869-8b0e-b76ca5cdf295",
"db_language_code": "sample string 7",
"db_title_id": "f910d4a0-3c46-437e-8231-d90c2790f96a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-22T04:06:36.107402+00:00",
"create_date": "2026-09-22T04:06:36.107402+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-22T04:06:36.107402+00:00"
}