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": "ac5b179e-d716-4cdf-ad4c-b24f36b998d1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7424704a-30ac-42a2-9840-fc389d418884",
"company_code": "sample string 5",
"company": {
"id": "c6a09b3a-11af-4f91-9691-d1d7af48dc0e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-19T16:21:31.5696074+00:00",
"sales_territory_id": "20e22fac-eab3-43d9-8531-a7beafac44a5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f4083b8b-821a-4bcf-9578-8292a5a4dfb5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "09e9df32-3dc1-4853-a882-905b2ca87a54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec475187-2bf0-4b9a-8eeb-85bca16d8921",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7f32a40-96ed-4886-955f-8bc8e17f7571",
"db_currency_id": "860e3c1f-bde1-47cd-8b85-dac76c0c7759",
"db_language_id": "9d50de94-a99a-4327-a355-1bceabaa6ee6",
"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-08-19T16:21:31.5696074+00:00"
},
"modified_dateutc": "2026-08-19T16:21:31.5696074+00:00"
},
"marketing_segment_id": "6a729050-a0ee-4498-b3a4-64f17dc06575",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "426df6a2-da3c-4892-b0da-3cb485d6c0eb",
"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": "19b32221-dd5f-4546-ac12-a12c05125df4",
"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": "747dc546-7794-4324-96d3-18c0496fc330",
"db_country_code": "sample string 28",
"feelist_id": "9cf6cf86-1df9-4af5-b557-07571cf1f3ad",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8783a651-8258-446c-a04e-b8a38d0497ec",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6594d3cb-7429-404c-84f9-33cb97cf40df",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-19T16:21:31.5696074+00:00",
"db_currency_id": "b6a4d857-33f8-4d17-846e-b5b07255a0ac",
"db_currency_code": "sample string 10"
},
"company_type_id": "67d45441-e0fb-4b84-aad3-e16ffe77ecf9",
"company_type_name": "sample string 32",
"company_type": {
"id": "8299a0d9-598b-4060-903e-2559d9f81d9d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7948f8a8-fca1-4286-8764-05f0cbd53a7f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8dc710cc-a70c-4948-b7a9-d1755ef67b4f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2033b548-31b7-4e3f-9280-138721f12084",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1b68451a-8cac-433e-ad7b-45b0d54dd6a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2e406a7c-426c-4c20-b0a6-49eb6b04e75c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-19T16:21:31.5696074+00:00"
},
"company_sector_id": "9c208275-c38f-4b54-aa86-d6a46119dc0b",
"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": "e9bddbed-1be2-45b7-be79-aa77ae8f124a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e296ffab-e568-4d20-a224-eb1954ba025b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "734e29f9-fca9-4d1f-a202-8ac3a069ebd1",
"account_manager_user_code": "sample string 56",
"company_status_id": "04774900-71ca-4d7e-be06-5b22ea0b76d0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-19T16:21:31.5696074+00:00",
"id2": 60
},
"db_language_id": "c6113b7a-384d-44c6-8d26-a5080ea4c22b",
"db_language_code": "sample string 7",
"db_title_id": "17545414-e314-4131-b99f-b82a719d2cb6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-19T16:21:31.5696074+00:00",
"create_date": "2026-08-19T16:21:31.5696074+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-08-19T16:21:31.5696074+00:00"
}