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": "e0b3da27-435c-4f6c-b6cc-38f73c3e5bb0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ec8c1a76-14e0-4399-88fd-ebf6a2ffe0e7",
"company_code": "sample string 5",
"company": {
"id": "48d05c2f-ebc3-4ae1-a6f6-1f283eebe71e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T14:50:45.7341172+00:00",
"sales_territory_id": "b3a175bf-7ecd-4479-9249-3f1610edcd84",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "74bf2063-0536-4f6b-a530-2bf95f2cba33",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ad7f1784-ea22-4dc9-911a-a3cf46d8d522",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a19cb57-636b-42d8-87d1-4179aacd2a8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e8f9281-40ce-4542-b76e-13a4a84af0ea",
"db_currency_id": "d3e50abf-3f80-4b83-912f-05a325089cac",
"db_language_id": "eb7b797f-e6c2-4bb2-9b09-52a2f32838e9",
"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-10T14:50:45.7341172+00:00"
},
"modified_dateutc": "2026-08-10T14:50:45.7341172+00:00"
},
"marketing_segment_id": "64a00fb2-4cf7-42a5-b7d2-418a9081de5b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "519dc2f4-59c0-4a67-9110-3d0e8c20d130",
"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": "7c6bba06-2612-43d2-8673-9af2638a4b22",
"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": "30f5fab7-e5eb-467a-b313-3826e71f3b95",
"db_country_code": "sample string 28",
"feelist_id": "1d13755e-6a0e-4dca-8fe6-a66b201bbaee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "16aaae41-d6bd-4305-ba21-2c4d718ba4e7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "961a2d64-dc7f-42f9-a157-1384e79afbe2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T14:50:45.7341172+00:00",
"db_currency_id": "76a5e7ea-8749-40b1-bd47-5f7002ef637e",
"db_currency_code": "sample string 10"
},
"company_type_id": "bfb6f78d-6182-4b0b-be08-92cfd044351f",
"company_type_name": "sample string 32",
"company_type": {
"id": "f54c075c-def8-4eed-91ac-b2783b117d14",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b3e43375-950e-4df7-9aa4-a8def191911a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a4f94e5d-18cc-48ad-98e6-8f98ecab6878",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a8f51205-6ae7-46c0-973e-16fa4f9eb206",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2dbcceb1-c2fa-49cf-9aa8-ea99f25b76e2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "489f56b5-9870-4a36-8bb3-622e38539e62",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T14:50:45.7341172+00:00"
},
"company_sector_id": "daf1b584-36fd-49e0-9558-4af98b843e54",
"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": "16066146-a468-42e1-b32c-22eaf5e11102",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "be21daa4-7421-4e04-a1f8-72b975784707",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3ef250a3-4432-4b32-b7cf-6ebb204a9fcf",
"account_manager_user_code": "sample string 56",
"company_status_id": "8537df35-97e0-47d4-9213-bfea31de726b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T14:50:45.7341172+00:00",
"id2": 60
},
"db_language_id": "bc632fb8-1818-43a4-8c51-729c5f92f97d",
"db_language_code": "sample string 7",
"db_title_id": "3423e2ca-a5bd-4390-b0d4-ec63362087a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T14:50:45.7341172+00:00",
"create_date": "2026-08-10T14:50:45.7341172+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-10T14:50:45.7341172+00:00"
}