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": "cf481e42-b209-4115-8d33-f23825ffa261",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dfa4fe11-5be5-4850-85ea-c6f63e5dae60",
"company_code": "sample string 5",
"company": {
"id": "84ef1f89-14a5-4cbf-98ee-9ef10c32b2ab",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-17T21:09:27.8483001+00:00",
"sales_territory_id": "a003ac0f-cfb0-4455-b90d-d3c8b44e4827",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9118d149-c2d2-4bd5-b66d-c73788cf64da",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e3baf9a7-63be-4a6b-8eb7-a3de3965e1fa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "168db400-093c-4cce-8e6f-b0941262d31c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c722e2e9-43dc-439d-8961-8e5134acd218",
"db_currency_id": "55bc4ec1-f374-410a-93e2-668511e00992",
"db_language_id": "9e373f81-d832-4fef-8e7c-984c0ce9b7a1",
"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-10-17T21:09:27.8483001+00:00"
},
"modified_dateutc": "2026-10-17T21:09:27.8483001+00:00"
},
"marketing_segment_id": "3ce724a5-1bc8-4170-b857-d9b132dcfef6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bca13d3d-822f-4357-b4b2-44a6a9a7f36c",
"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": "bb47e34a-c471-4c4f-a9fe-1f60a3aa0dd5",
"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": "cad790c9-2a56-4b9e-82f9-e64dfa650e76",
"db_country_code": "sample string 28",
"feelist_id": "65ba22bc-66a6-46b2-9783-fa909648cdf8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3c98704d-cadc-48f7-8bbc-9f2db2def92d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fbb46410-39f9-4cda-bb3c-151b1b2845d0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-17T21:09:27.8483001+00:00",
"db_currency_id": "e52fe984-36ce-4324-8982-6c5110e3eaa2",
"db_currency_code": "sample string 10"
},
"company_type_id": "b931bdc5-777a-4c21-a61b-3cd284e987c6",
"company_type_name": "sample string 32",
"company_type": {
"id": "55580558-8135-4d1d-a1ed-ffe3d707374a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4533e65b-0bb4-4800-9e0d-8a96431029fd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "14dd1ce1-2c70-46a0-a3ce-220c21a6bcd6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "db8baa8b-dcb1-4d36-a6d7-631a69ec1766",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "42736650-00b4-40e0-a26a-dcd136f32e51",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "751d7fc9-c07b-426d-a5e7-3f3fefd0abc4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-17T21:09:27.8483001+00:00"
},
"company_sector_id": "cb421081-f232-41f4-b3c7-eea919ca6c38",
"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": "6a66c6b1-f2db-4927-801d-8c931da9d700",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c4e6a6cd-16ec-4bd7-8a64-cd550ef25305",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6c87196d-bf19-4ea9-aa1f-3df9b263f183",
"account_manager_user_code": "sample string 56",
"company_status_id": "99ae5071-163c-4db7-b70f-17944896ac37",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-17T21:09:27.8483001+00:00",
"id2": 60
},
"db_language_id": "b33a4649-5ad7-4b38-9d56-e1462f680857",
"db_language_code": "sample string 7",
"db_title_id": "fb2840cc-561f-4eab-b461-994411c6fd8c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-17T21:09:27.8483001+00:00",
"create_date": "2026-10-17T21:09:27.8483001+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-10-17T21:09:27.8483001+00:00"
}