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": "f2fd4db3-7edb-4a98-bdfb-f5ea90854a39",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "39d8f4a5-c17e-416e-8df8-abf196b1f726",
"company_code": "sample string 5",
"company": {
"id": "3e9e3288-8bf8-433c-aaab-dc2ba43552c2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-09T08:18:27.449389+00:00",
"sales_territory_id": "2aae8329-b4ac-467c-a98e-e16a15a43919",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d61778c7-ef43-4157-bf6c-64b0dfaf37e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "17f80988-ec91-48b1-a493-8718830b8528",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7c563a9e-b7b1-4f16-839a-cb1458f6b560",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54da5235-1efa-4f74-9c16-720d84d0cd68",
"db_currency_id": "c16e8a57-47cf-42e6-89e6-acadc1a069a5",
"db_language_id": "c278db1d-6b78-4f10-9051-a9d22ba47326",
"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-06-09T08:18:27.449389+00:00"
},
"modified_dateutc": "2026-06-09T08:18:27.449389+00:00"
},
"marketing_segment_id": "bc87abf6-be4f-475a-bd9e-1562e835d1b4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3a6130fd-2a8f-40ab-b562-5e8dbb46c848",
"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": "a3f744da-d194-4d57-a8cc-06f827f2b237",
"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": "25067bc7-3a7a-406d-8215-9dfcb3187969",
"db_country_code": "sample string 28",
"feelist_id": "62a86cd3-38e5-46e3-9d1c-b3b69c18ed63",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "32a1ec96-14bf-4552-9ea8-0b8e8423ff3c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "037dd518-fe02-41e8-8769-f916b4a44d30",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-09T08:18:27.449389+00:00",
"db_currency_id": "d7f3414b-31e4-4e49-96ee-e4eae3c564b7",
"db_currency_code": "sample string 10"
},
"company_type_id": "0995f5ab-1c5c-4f90-bd7a-d75d45b316f8",
"company_type_name": "sample string 32",
"company_type": {
"id": "1bfa60e0-42ba-446b-9f7e-5ff6250163dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "03f4c5a8-4878-4eb8-8324-5e9f3479ecf2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c550b24f-7b30-4394-871b-913e8c2f7c75",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "540055a3-a64c-4f91-83e5-f00d6470eb77",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8e19415d-1356-468b-978f-58dacfc33d9e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "771a1690-50df-4687-ac49-7580ba703218",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-09T08:18:27.449389+00:00"
},
"company_sector_id": "5ee02fdf-6efa-47e5-930c-b0077b08c643",
"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": "cf29607f-44e7-4909-893f-9608cf15e616",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2b80d08d-20f3-491e-903f-a6d7885c71de",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d63bce23-e3bb-454d-ab95-1f1dcc51c6ae",
"account_manager_user_code": "sample string 56",
"company_status_id": "c7cb2128-c0a2-4beb-addc-6b4a104ac0bf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-09T08:18:27.449389+00:00",
"id2": 60
},
"db_language_id": "59eeca6f-8f1d-40e4-8be1-435555d44784",
"db_language_code": "sample string 7",
"db_title_id": "f5c7cc42-72ac-478a-986e-9195c5b8e52e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-09T08:18:27.449389+00:00",
"create_date": "2026-06-09T08:18:27.449389+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-06-09T08:18:27.449389+00:00"
}