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": "281ddc70-2e4c-4f63-a145-a67e70cf0a2f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cf440c34-15e0-4822-a958-8d7b7c12c79b",
"company_code": "sample string 5",
"company": {
"id": "52fc84f7-2949-4e18-b37a-cb7bfbe32649",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-03T14:10:34.4699631+00:00",
"sales_territory_id": "5fb91a52-a272-4d6b-a54a-0544c79bd608",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "06b2a262-c7b9-4c06-aa73-e6278a1b01c6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d9f935e-cc75-41cd-b971-83ba023c120b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5a34a85-bd96-4c55-8748-dc64307aff49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "999a700c-78e7-4187-9e07-c0ba8221fdae",
"db_currency_id": "a08a65c6-eec9-4ac7-bae8-6040de063047",
"db_language_id": "bfa159f4-ff2a-470b-96b2-0d746680eb23",
"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-07-03T14:10:34.4699631+00:00"
},
"modified_dateutc": "2026-07-03T14:10:34.4699631+00:00"
},
"marketing_segment_id": "58ce04d2-b130-4e73-b1bf-500ad1386c7b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "112610d7-31bd-4402-9491-af6dc994c02d",
"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": "dfc50a9c-ef25-48d7-9b8e-195fde12be79",
"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": "1345d183-2c99-4be8-887e-52525fa7d6bf",
"db_country_code": "sample string 28",
"feelist_id": "c2649eae-85e7-4928-9621-0fbfd7eb2a56",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "767695c1-5998-476b-8303-ec8e2bbf715c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a9de9cf2-6c06-4713-b406-011eea6ffc83",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-03T14:10:34.4699631+00:00",
"db_currency_id": "01ece862-9fa0-464f-900b-84ffdfd48a24",
"db_currency_code": "sample string 10"
},
"company_type_id": "5652df52-b3b1-4886-aba7-f2fb3effc25d",
"company_type_name": "sample string 32",
"company_type": {
"id": "20ab4486-8feb-4b27-914a-c709cd9f626a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ba34c7fe-fcbe-4de3-bb7d-9622ce1509fd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "00344867-7cd5-4100-8f08-bd3794fcc9e8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ea1e0680-0eb9-4f77-9bf1-0f21eef6993a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "65d7fec8-ad5f-4ef5-af34-fd7bcbd29efe",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9a316d1e-6962-41b7-8acf-55ea31a4fc80",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-03T14:10:34.4699631+00:00"
},
"company_sector_id": "ce3800af-3c24-4856-8a80-355a600c3939",
"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": "c498e0da-0d60-462b-8913-997dc14e1931",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "544d680b-7848-4a3a-a39b-58e35d86e1ca",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c48b977a-4fef-47c7-a78d-9869156f5f91",
"account_manager_user_code": "sample string 56",
"company_status_id": "1348ba20-24e7-4fce-b446-d3a6b1978415",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-03T14:10:34.4699631+00:00",
"id2": 60
},
"db_language_id": "1d897408-7ec4-4f91-abe0-2bdbdfbab319",
"db_language_code": "sample string 7",
"db_title_id": "a3e9ec4f-36e7-478c-a2f6-89588a19f96e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-03T14:10:34.4699631+00:00",
"create_date": "2026-07-03T14:10:34.4699631+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-07-03T14:10:34.4699631+00:00"
}