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": "e3189a4d-f62e-483b-90f6-73135fac3ea4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5c4769a4-c88f-456c-818d-856e27e66814",
"company_code": "sample string 5",
"company": {
"id": "416acfaa-bf7e-4c86-9dbe-85d59c86272f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-30T02:29:05.2579293+00:00",
"sales_territory_id": "54b8d29d-9f3c-4424-a523-a17c90050cca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "11375f3d-6c33-4e21-bd0a-9b449d8cb3f4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "40753e82-6177-48ef-9808-ccfc76914b47",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d3401e5-4a84-45df-9d29-974c5a7d4864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a342a68-92bb-4bff-9f8e-202b78a9ba02",
"db_currency_id": "9d0f30e9-9f41-4c62-bbff-6d45b446aa4d",
"db_language_id": "ca11009e-115f-41bf-9ce8-87b27a42cbaa",
"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-30T02:29:05.2579293+00:00"
},
"modified_dateutc": "2026-08-30T02:29:05.2579293+00:00"
},
"marketing_segment_id": "d963f182-daa9-422a-849c-96efa648c8fa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bf72562e-a1a3-46df-8dcf-49598fc8eb4d",
"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": "de92e548-2efb-4e5a-a454-3b816b7c6356",
"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": "f5c7453d-facb-4506-a83c-209a68920abd",
"db_country_code": "sample string 28",
"feelist_id": "ca199bba-78dd-430c-8af2-1726b75091b1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0de86296-6883-45ab-9f49-cabbfb18aff5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4cd4f79a-edb4-47ff-a871-3c4b7b8a5dfa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-30T02:29:05.2579293+00:00",
"db_currency_id": "27d74fc7-790d-4956-89db-3c9f18ae49f4",
"db_currency_code": "sample string 10"
},
"company_type_id": "5b9f255e-fb6f-4fa5-850a-a622bf7e9bd8",
"company_type_name": "sample string 32",
"company_type": {
"id": "390bbb62-4afa-4989-a786-95695513fc38",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7cb9acbf-7e0c-4602-a055-2be6c4d6044c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "641e0f8e-a227-4998-8eb9-eb92bd2a9d79",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c4346918-95db-48af-ab0f-24d381693adb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5aa48d59-898c-45cb-bd15-fd61c7a48c96",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2e70ed91-f730-4a8d-b4ed-1aecb1a9a3bc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-30T02:29:05.2579293+00:00"
},
"company_sector_id": "cb3c4c9c-89a8-4eee-96aa-cba0e642942c",
"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": "3fa5daa1-aa51-402c-8467-94404c1a3be3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eab4b3ff-7c65-4218-a4c2-50d80e411587",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "149f71f9-84af-4b84-b5e7-859b3e50e7c2",
"account_manager_user_code": "sample string 56",
"company_status_id": "a9d16b79-f27d-497e-966c-0e4ca3b42e8c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-30T02:29:05.2579293+00:00",
"id2": 60
},
"db_language_id": "88a3b73f-b142-4eae-80c4-7b21bfe23318",
"db_language_code": "sample string 7",
"db_title_id": "75c5b57d-3b26-4c74-80ef-1bacd202bd03",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-30T02:29:05.2579293+00:00",
"create_date": "2026-08-30T02:29:05.2579293+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-30T02:29:05.2579293+00:00"
}