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": "72a35681-2fdf-40d2-b60d-bac1da0cd102",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e6021c2d-94f1-40a9-b46b-156721b8780c",
"company_code": "sample string 5",
"company": {
"id": "41c7caaf-dc7b-4657-9c0d-38d446df6a0a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-05T12:25:44.2435388+00:00",
"sales_territory_id": "3dc0952b-60fc-48a1-a67c-62dcbf5bfdf0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a66e2fee-5fbc-479d-ae6c-3936e484e250",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8bb0121-3927-42bf-8254-df3d3ed316cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d596fcd9-052b-400b-875b-fbe2cc31ea98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ab9a2892-9017-418c-a586-8ef081903e7b",
"db_currency_id": "59f08e15-a7a3-4b77-a865-e869e10964bb",
"db_language_id": "251ded8d-33ce-4ffd-8e38-b958df1d0409",
"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": "2025-09-05T12:25:44.2435388+00:00"
},
"modified_dateutc": "2025-09-05T12:25:44.2435388+00:00"
},
"marketing_segment_id": "b0d391ab-4baa-4b69-a37a-de458cdf7a34",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e970b5ac-e64b-4c19-a6f3-f449a09d8aba",
"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": "3d1c317c-700c-4107-b4a6-a50ceb49f1fa",
"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": "b5347d75-1a03-422e-a2cd-e19eb97fd25a",
"db_country_code": "sample string 28",
"feelist_id": "5ec51707-3f67-42ab-9766-064a94b04119",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bd402ff0-3227-41e6-98ac-6febf82e27bf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a323e7a3-a973-443b-897b-9e37671e2abb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-05T12:25:44.2435388+00:00",
"db_currency_id": "de0944f8-14c2-4e28-bccf-f4581b2a2503",
"db_currency_code": "sample string 10"
},
"company_type_id": "8d72fe1a-f4bd-4f8b-b87f-3f5a9753c92e",
"company_type_name": "sample string 32",
"company_type": {
"id": "47698c75-5701-47c3-96da-c7f1b9bbe223",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "17b512ec-5061-489a-9850-f8cb98a85061",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c1ebaf43-1c4c-4320-995a-42322f089a50",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ec19bb28-ad1e-4f2c-a13c-74aaad8b6d7b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ee9fd47f-bc1e-4676-8d3a-8b623d74a5e4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "100245c2-a857-4319-8288-691b7a6d08d5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-05T12:25:44.2435388+00:00"
},
"company_sector_id": "5a459955-c51d-46cb-bca8-b06d94956e90",
"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": "5621f2b4-779a-4157-bfe3-a943f1da489d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ccf73a34-39f3-493c-8f54-e03873d505a0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fb00a1ea-e61e-4d96-98df-557c80cd9d06",
"account_manager_user_code": "sample string 56",
"company_status_id": "7ec71790-5012-43ae-8a49-207a1a2c4049",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-05T12:25:44.2435388+00:00",
"id2": 60
},
"db_language_id": "919da69f-628c-4dc5-98a5-8ad09c2c0b8c",
"db_language_code": "sample string 7",
"db_title_id": "e6a88cd3-a72f-4c32-9f9f-2175d1a98784",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-05T12:25:44.2435388+00:00",
"create_date": "2025-09-05T12:25:44.2435388+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": "2025-09-05T12:25:44.2435388+00:00"
}