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": "f1691e3f-a7e8-4eb7-8247-751de3eac7b0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2cc4e811-70e3-42be-8acd-f03a79c8aca1",
"company_code": "sample string 5",
"company": {
"id": "73334e31-bbdf-4841-8be2-0f82f0227123",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-13T04:53:20.3486559+00:00",
"sales_territory_id": "e7c127c5-243f-4958-80c9-80d47fecf0d4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b57c97e1-9cae-4668-978a-191289a3eb28",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5f334a84-6e58-4291-88f3-5a8992e39e99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b7b64f06-3717-4ed5-b6ba-6669af1dbd12",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc8450d-919c-4943-a637-2fba0a40ec29",
"db_currency_id": "36f16294-fa89-4485-a2e7-14aac96ea1cf",
"db_language_id": "34cdafa6-1e2e-4f6e-9935-5ba798f3b301",
"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-04-13T04:53:20.3486559+00:00"
},
"modified_dateutc": "2026-04-13T04:53:20.3486559+00:00"
},
"marketing_segment_id": "6455de43-56ec-40c5-a77b-87737da1d7cc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "26f61533-71c1-4450-9f45-61c8cedecf42",
"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": "c7966e55-7f21-43b4-9cd5-d0cd43394efb",
"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": "14798d8e-1d8e-4f2b-a4f8-09467aa5cdd9",
"db_country_code": "sample string 28",
"feelist_id": "2b81e857-a123-4764-9fad-a2ae36989804",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b55a788a-9d1b-49d2-a59c-5eaebc6424c4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ed80a625-2f76-4296-9c95-a0c5df2bf1b8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-13T04:53:20.3486559+00:00",
"db_currency_id": "e6fabae7-fd1a-4fbb-9dc3-94920b50aeca",
"db_currency_code": "sample string 10"
},
"company_type_id": "3d8814c5-5ed4-4a87-8555-a8afedfc0c3e",
"company_type_name": "sample string 32",
"company_type": {
"id": "4706aaf4-4299-49db-b750-1a119b488cc3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eaf90131-42e7-4a4b-91bb-f3864b98ff8c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2cc5f2d6-e575-45ba-ac2e-16c4eb7a045a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "911930d4-0710-4eeb-9c27-ef289da72ab4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fbae101a-01f6-43cb-9384-1306a49c7c4d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "feaa7972-55d4-4c04-acf4-5107d5d0c095",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-13T04:53:20.3486559+00:00"
},
"company_sector_id": "2a224ff4-8c88-4cb3-b780-94918a30c34d",
"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": "15424734-5cdd-41b1-b647-f7681c531e3d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b9dc2d53-70e6-409a-bbf0-9fec72766146",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "583d58ad-393a-4312-8c0e-dff39e0eb846",
"account_manager_user_code": "sample string 56",
"company_status_id": "315ae929-5956-4c61-921e-cd478789a6e9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-13T04:53:20.3486559+00:00",
"id2": 60
},
"db_language_id": "be1d8d0b-142b-41af-a265-9a98faae8378",
"db_language_code": "sample string 7",
"db_title_id": "c3fe8940-941a-46ed-aa20-36939d6bddc7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-13T04:53:20.3486559+00:00",
"create_date": "2026-04-13T04:53:20.3486559+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-04-13T04:53:20.3486559+00:00"
}