Retrieves all the contacts
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": "62034c63-14f2-4e24-8150-565e2f343b52",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0cc63b0d-8b11-4203-87f5-9b01be20e281",
"company_code": "sample string 5",
"company": {
"id": "29d1b6ef-430c-4abb-b5dc-6ee888bde5cb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-31T02:44:42.796456+00:00",
"sales_territory_id": "e764e6c6-b3e4-417b-bb21-e6ec26adcdf6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b9d5d53d-d8ae-4b14-8f9e-559ed884341e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e68ce9f4-ad2b-4d78-b0ad-888ae29c3cab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9e4c5888-bc76-4c70-bd6b-45657169326a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4952b85-98ed-430b-9e43-495ded36c694",
"db_currency_id": "e739c666-624f-4979-9919-27c143000077",
"db_language_id": "79bcb30b-2db9-483d-9d92-12162ab12631",
"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-10-31T02:44:42.796456+00:00"
},
"modified_dateutc": "2025-10-31T02:44:42.796456+00:00"
},
"marketing_segment_id": "f8693a7b-0ff6-439a-9e1d-92f7240d89a6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b2f31e9d-1f02-453e-9c40-b5b37f17fd1d",
"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": "6e958689-b7cb-4e14-b0e8-1dfec1e6c880",
"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": "7a0d6976-17b2-4721-9b77-0a94573ead8f",
"db_country_code": "sample string 28",
"feelist_id": "5ffcffbc-4cdc-4e8f-9fae-0af3eec13f66",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0d5a7771-1ea7-440c-8a4d-ecaed6f3f406",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9ca8655e-defe-4cb6-8fe2-130b80b37abd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-31T02:44:42.796456+00:00",
"db_currency_id": "7448cfcc-6376-4d03-84d4-2b8be435aa13",
"db_currency_code": "sample string 10"
},
"company_type_id": "3f44da70-1c80-4699-b9bc-0da3a9bdd163",
"company_type_name": "sample string 32",
"company_type": {
"id": "9d3fce58-b8ce-4c33-a249-a7b9f47465b6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "538c49f8-790b-473f-8b39-db8cb7c9606c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "65db0d2a-7c26-4c39-80a6-f02752c67adf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "11d3eec1-ffd6-4399-bef6-7af77b283093",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "19439073-1fe4-4567-be32-84f501a841dd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d6c4b976-18e0-4170-b005-87a923ecc166",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-31T02:44:42.796456+00:00"
},
"company_sector_id": "3e7a7cac-113e-48da-ae29-38e52e998ce8",
"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": "3c6e9c87-4e58-448e-96b0-f11d495b198c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b646a83c-b33e-4e21-90dc-8a6832ccc429",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f8fad4d2-9293-474d-9564-2cd3169b1f4d",
"account_manager_user_code": "sample string 56",
"company_status_id": "107d130d-30ea-41f7-ab43-0218c60bd27c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-31T02:44:42.796456+00:00",
"id2": 60
},
"db_language_id": "541dc932-10c8-40e1-8591-7a36877d6bd9",
"db_language_code": "sample string 7",
"db_title_id": "c4447223-d0e3-4b73-8ea2-7356605c49c3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-31T02:44:42.796456+00:00",
"create_date": "2025-10-31T02:44:42.796456+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-10-31T02:44:42.796456+00:00"
}