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": "1454d8d4-e2c1-44ed-8d89-dafba7209504",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5b0c9a8f-4762-46f7-bfaa-dbdcef9faca2",
"company_code": "sample string 5",
"company": {
"id": "d0fb5c4b-22bc-4091-bb57-fcab8653b828",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-01T02:40:03.089159+00:00",
"sales_territory_id": "cd595624-aede-449d-ace1-cb7494c1e7cd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "167e032b-5d31-4776-9dfe-41de1131e498",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb94e183-7591-44d5-b851-861243ef24eb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a0e7ac85-d667-416c-b69b-f5b260481945",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9aad571a-4fea-4c24-898a-df77b7a7be88",
"db_currency_id": "dfcab5fe-77c1-43a5-b972-1e4587cd362e",
"db_language_id": "61496b20-e996-43c3-a856-c5fc54d1a832",
"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-01T02:40:03.089159+00:00"
},
"modified_dateutc": "2026-01-01T02:40:03.089159+00:00"
},
"marketing_segment_id": "2da29ee1-a59c-4cb7-8f7f-58a973806a04",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "35517999-9c1a-4b6a-8acf-c714996cc006",
"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": "2ce84cfc-e911-461a-87fa-d305e6b97b10",
"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": "fc81df18-4258-461a-ad69-0e523d4267b2",
"db_country_code": "sample string 28",
"feelist_id": "5cb685fc-c44c-4fa9-b7c9-ddb672a3f6d4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2a244755-c19f-4aa5-bc70-e79077ec1565",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e1b8b2ea-84f5-4c57-975f-9e23d61353ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-01T02:40:03.089159+00:00",
"db_currency_id": "741d25fc-7154-4b13-94a3-7b862f77d5cf",
"db_currency_code": "sample string 10"
},
"company_type_id": "2e2b143a-14e8-4387-bfcb-3e0aa49521f3",
"company_type_name": "sample string 32",
"company_type": {
"id": "4a5fac09-3835-422e-9438-92285e6a9e1f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "61c38b83-119f-49f5-bc57-650a29b25429",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a18339d3-57a7-407a-9c40-99c97c7cef94",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7737add3-125c-4958-8de9-472946b3b929",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f8d8a358-939e-4448-9572-f693c26b8a35",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9e3483a1-656b-4925-a733-00e34aed7509",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-01T02:40:03.089159+00:00"
},
"company_sector_id": "d366d46b-c4b9-464b-85ed-968f95621cd0",
"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": "caa12fa4-73a3-4222-81a2-6ad44e6e37be",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "73b15fae-50b3-4f94-8f35-d243f031d72a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "62ac1872-62e2-47bf-9f6c-5af7c9037f2e",
"account_manager_user_code": "sample string 56",
"company_status_id": "10eb601a-72ea-4f64-91da-1dc656612089",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-01T02:40:03.089159+00:00",
"id2": 60
},
"db_language_id": "2fba4ead-cbea-4f98-96aa-b58a5c93e748",
"db_language_code": "sample string 7",
"db_title_id": "ed011cd5-d77a-4b9a-91ec-c9e268ba968e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-01T02:40:03.089159+00:00",
"create_date": "2026-01-01T02:40:03.089159+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-01T02:40:03.089159+00:00"
}