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": "a03fdea9-8da1-4cc2-911b-b1e4859d03b3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "caa3edee-fb4a-48cb-bb12-727274e4aa2b",
"company_code": "sample string 5",
"company": {
"id": "233bf206-51b3-427c-8dfb-cc7bae1a9009",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T03:50:14.0336448+00:00",
"sales_territory_id": "2389a327-614b-4b29-b487-a3c8c9dc9bc7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "012ccce4-2ee6-4419-b6fc-1598f5d2988f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "61227d96-ad60-4396-9db3-31d074340779",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f275350f-b69a-47dc-90e0-1c29097c5365",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59beb202-a145-4356-bec1-fa4e20df1abb",
"db_currency_id": "c229d480-6c2d-4e18-bdd3-b620e1b98178",
"db_language_id": "1ccb15a1-4e9d-4c0a-a502-d320bfc60ccb",
"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-18T03:50:14.0336448+00:00"
},
"modified_dateutc": "2026-04-18T03:50:14.0336448+00:00"
},
"marketing_segment_id": "64f9d5ce-3098-4318-a774-0e5118659be1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "72dafe11-8d4d-45ae-9306-1e7e0150be34",
"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": "d6a1c243-5a0f-4eeb-8059-4eafb5c5c6c3",
"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": "b3174142-248d-4f1b-94d7-0bb91aea2c9f",
"db_country_code": "sample string 28",
"feelist_id": "4336f451-828f-4cbd-ae03-11d55c93583d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5cd77606-b2f9-473d-bf64-b0ad04c2fb14",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4f49bdce-688c-48cb-ba22-ffe256030ef5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T03:50:14.0336448+00:00",
"db_currency_id": "c4f157e6-8e4a-4e0c-ac02-9f897149b0fe",
"db_currency_code": "sample string 10"
},
"company_type_id": "5cabc49a-5e3a-4cb4-8018-235281cbb4f9",
"company_type_name": "sample string 32",
"company_type": {
"id": "e2f4fe99-231b-4355-b929-975521658226",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "22a9d84d-2468-4290-998d-1a35fbce8b28",
"sales_organization_code": "sample string 5"
},
"db_language_id": "72e83fb4-1408-40e2-968d-049e16c91d95",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b60d5f04-1a1e-4416-b9fd-c2841a340fa3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "15a0e2f4-0168-4b3c-8977-93915bf00ecb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "afc6b9e2-d550-457f-83df-8393e682b071",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T03:50:14.0336448+00:00"
},
"company_sector_id": "2c415849-8e07-49d0-b79d-4331aed7bc17",
"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": "121bbd1b-e5b5-447a-8902-ec306bfb6052",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4cc626a7-a7fa-454d-bc8d-83a4d711e990",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fe47bed3-3db0-44d6-b764-bf65d08fddc4",
"account_manager_user_code": "sample string 56",
"company_status_id": "b0749d85-58c8-4248-864a-d44b89ce703e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T03:50:14.0336448+00:00",
"id2": 60
},
"db_language_id": "e1a1caed-9c6b-43d2-9cef-9df5bc55a5b1",
"db_language_code": "sample string 7",
"db_title_id": "0b9dd8e1-1674-4830-a6b4-b4ab5ab3300a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T03:50:14.0336448+00:00",
"create_date": "2026-04-18T03:50:14.0336448+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-18T03:50:14.0336448+00:00"
}