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": "422a8392-59ea-47f7-9d2e-de7fa0903e4c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "81c449f6-f362-4f4e-925f-f10d1befc057",
"company_code": "sample string 5",
"company": {
"id": "158da655-0786-41c5-b7cf-f8fcbd2e2713",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-06T15:04:20.2062687+00:00",
"sales_territory_id": "dfa00160-32cf-4d1a-b4f3-08f4b96d31ed",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7999554b-c1cb-4cb5-ac2d-ae0b0f008498",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4ace0d6a-8670-42fe-95f4-04f463e4bd95",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e6cc9035-a0ba-49b2-96e3-a1bed05ba608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2126773a-695a-4b20-b585-d466f64c8902",
"db_currency_id": "285e9928-1bc4-4127-b01c-ac2e2c8d8940",
"db_language_id": "7d7f2a82-c26e-44c5-8aa7-2c5de7985817",
"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-06T15:04:20.2062687+00:00"
},
"modified_dateutc": "2026-10-06T15:04:20.2062687+00:00"
},
"marketing_segment_id": "b6dff280-eb6f-46de-bbec-5bec29f524f6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dcbef52d-f29b-4e5f-b3c1-f8a4b79b6698",
"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": "a4128973-0b61-44e5-b696-47906576cbdd",
"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": "b2f7c525-78f7-4ad5-bdba-223401b7196b",
"db_country_code": "sample string 28",
"feelist_id": "afb4803e-561a-4269-9703-4d0ad5db24d6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "82a80203-b8ce-4482-9946-ff7709847656",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "65d707e3-7a4f-4aa4-819f-c006c02ce7a4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-06T15:04:20.2062687+00:00",
"db_currency_id": "7fff7b87-1c75-4d98-ac4d-3fc8ae83e35c",
"db_currency_code": "sample string 10"
},
"company_type_id": "bd11d993-a48b-4a76-a838-246567a8e19f",
"company_type_name": "sample string 32",
"company_type": {
"id": "ab1a8575-7513-4276-be97-2d6ac874ee3c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "27eb39d8-8be6-406d-94d8-4c2892b5c804",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4c13373f-f8dc-4838-a230-59a9d53692ca",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "811ae8f6-fe67-4440-ba91-df10605d4735",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8cb655ec-d6b9-4209-aa31-45f993aa65a2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bcc09688-3207-4218-ba01-1a4a34ef183e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-06T15:04:20.2062687+00:00"
},
"company_sector_id": "442448d5-8889-45d7-af67-fec28b7aaea6",
"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": "f372359e-ca18-4ff0-8ac9-6dbe0bd0e2e0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9ca28df2-4485-4093-9f8d-c096b4e479e7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "43000ae5-cc0f-4174-b6e8-d2240d585002",
"account_manager_user_code": "sample string 56",
"company_status_id": "88cf1203-43eb-4289-88d5-424902be712a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-06T15:04:20.2062687+00:00",
"id2": 60
},
"db_language_id": "73b49d72-769c-4ce2-a654-7fdf06bf3e80",
"db_language_code": "sample string 7",
"db_title_id": "9cb8e33b-cc38-4046-8d2e-32b5cfe2df51",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-06T15:04:20.2062687+00:00",
"create_date": "2026-10-06T15:04:20.2062687+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-06T15:04:20.2062687+00:00"
}