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": "b90d06a8-b8e9-406b-a816-71d42242c4dc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3850c8f4-cca3-48ee-8993-9aeae991182f",
"company_code": "sample string 5",
"company": {
"id": "de5f3268-590a-44cc-8361-4ad76c535d87",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-09T04:03:35.4886158+00:00",
"sales_territory_id": "c72c71f0-a46b-4e47-99d6-9be08c4aeba5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a555c6a0-8045-4ae5-b156-c0e403ac0dc4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c1665d1c-0aa8-4870-b408-3ef715fe4cae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6133a9fd-cb15-4ac9-98c3-9cc2ca70f21a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4756cf2-0cde-4b62-999c-096d3fb3cc1f",
"db_currency_id": "38b3ef5b-91c2-48e7-82d8-ce3265b6d65c",
"db_language_id": "d1b540f2-f022-4090-aad6-b02160d712bd",
"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-02-09T04:03:35.4886158+00:00"
},
"modified_dateutc": "2026-02-09T04:03:35.4886158+00:00"
},
"marketing_segment_id": "0d7d762e-332e-4aa4-87b5-b492b9bcf909",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dafbdbc7-9d90-45f3-a636-655b4ac25dbb",
"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": "4e09dadf-6cd2-43e7-84f7-bd5648659236",
"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": "2f0c3be9-ea45-423d-a4a7-c901040d4880",
"db_country_code": "sample string 28",
"feelist_id": "ffbed54e-4012-4114-be3e-5f43d9c077b6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f7af8f14-e2f4-4a7b-81b4-554d28de544b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a9e52cbe-af12-4e85-8901-6ebad81fe554",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-09T04:03:35.4886158+00:00",
"db_currency_id": "91fa6d5e-9b81-442b-818a-8a6c2f2e3592",
"db_currency_code": "sample string 10"
},
"company_type_id": "e42b64f5-9e82-478c-a132-4b297d224784",
"company_type_name": "sample string 32",
"company_type": {
"id": "cc293e21-f24b-4ff2-bfae-2fed7c27023d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85646ce1-66bb-48bc-b242-1690de79d681",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8b28ea10-c071-4d77-84ea-2474d96b09ed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cc481e39-0fb5-4d75-965c-ddebf4e145df",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2788f1ac-6ccb-4e70-b2cb-36cc1eab1eab",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2a52ac74-0444-4e88-815a-89f9dc5b8002",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-09T04:03:35.4886158+00:00"
},
"company_sector_id": "d2ac1ef0-d934-46b8-9f26-4f123ac2df87",
"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": "8fb7b9f0-0044-4c1e-9235-9b3b6bd62096",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d9e0ec44-76bd-407d-9ecc-ed14f9e8ca23",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "35d6d681-fe86-4ae6-8be1-bec87e6eda22",
"account_manager_user_code": "sample string 56",
"company_status_id": "08513b09-1ed0-4dc7-a177-50e876f7a25b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-09T04:03:35.4886158+00:00",
"id2": 60
},
"db_language_id": "0af73bc8-b7f8-449b-876d-7cfca6df600f",
"db_language_code": "sample string 7",
"db_title_id": "71bf6f62-17b8-48d1-8f62-5e9e464061e3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-09T04:03:35.4886158+00:00",
"create_date": "2026-02-09T04:03:35.4886158+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-02-09T04:03:35.4886158+00:00"
}