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": "739b5907-490e-4029-8b18-28d0174b2d93",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f7d2514b-d853-4fef-aa4c-85cb1d6127f1",
"company_code": "sample string 5",
"company": {
"id": "33b36afd-83c8-47d1-868b-5d0ca4d40ab2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T15:23:51.7183693+00:00",
"sales_territory_id": "dc8cd72e-500a-49cb-863d-ecb04c756ee4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bcb6c3ad-690d-49d7-a9f2-d89dc6c8b272",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "84ce2935-e7b4-45f7-98c1-26fd07d9b14e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f98b2a14-76b8-41fc-a3e1-98412433860a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6afd22a9-78dd-42e8-9f22-2a400c8b2d96",
"db_currency_id": "78cef46c-920a-4188-a379-99fec84dd4f9",
"db_language_id": "4a5010fe-d009-4217-b827-d2cb835c8286",
"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-03-12T15:23:51.7183693+00:00"
},
"modified_dateutc": "2026-03-12T15:23:51.7183693+00:00"
},
"marketing_segment_id": "5244a93e-14c9-416b-b47a-99da438bfaa0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7f287235-74c0-40be-8ae8-28b69199fe22",
"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": "777e63bc-1da3-4391-8475-9eccdc03a148",
"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": "34069b6b-4a05-47bc-9359-39b4f1b84550",
"db_country_code": "sample string 28",
"feelist_id": "e194d571-fa5d-4f25-8169-2e50705c48c3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a1d32952-c586-4dbc-8aa4-865cb9244d0c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "83c81ded-1865-483f-bd29-c656d79c085d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T15:23:51.7183693+00:00",
"db_currency_id": "d399206b-2249-49dc-86c4-5a493dd00cfb",
"db_currency_code": "sample string 10"
},
"company_type_id": "c78fa762-7723-4492-986e-cc170ba9e533",
"company_type_name": "sample string 32",
"company_type": {
"id": "ac6b3a3a-c148-44de-8313-642cbe271909",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "565ac128-610f-4f45-bbe8-59eedb0f5eba",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d12b36ba-a66a-4dc7-b1f8-c7f15b6f85f5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d2c8b79e-30f6-4cf6-8eff-fa4904beea4f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aa54eaaa-15c1-42b3-8626-ca61bcb4daae",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "86098810-730b-4b3e-b32f-0e6ca45b9239",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T15:23:51.7183693+00:00"
},
"company_sector_id": "95e7ab63-d20c-45aa-ba24-a844db86293a",
"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": "083e5291-e909-4477-8a8d-e9d39d762cd5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "50b51b1f-0a71-45d2-9999-449e4d7b5699",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3b0ac34a-3ea2-4e91-b9ec-e9b562eec25d",
"account_manager_user_code": "sample string 56",
"company_status_id": "727b2659-022a-4ce8-91b6-13b07b456d36",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T15:23:51.7183693+00:00",
"id2": 60
},
"db_language_id": "d46ef7ee-e635-4356-befa-df3e703f10bc",
"db_language_code": "sample string 7",
"db_title_id": "bdae2334-d1fb-4d9a-9739-a9201364805c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T15:23:51.7183693+00:00",
"create_date": "2026-03-12T15:23:51.7183693+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-03-12T15:23:51.7183693+00:00"
}