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": "f314b71f-8bbf-482f-939a-dcb2768db8f1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "933edea1-b786-45be-b31f-e772c7e3197c",
"company_code": "sample string 5",
"company": {
"id": "fb61843a-6403-4944-975e-3d58fbf843ba",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-28T20:27:52.260023+00:00",
"sales_territory_id": "db2ccdc9-b2f8-4b98-9086-08291ed98ab9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b9903de3-0d37-4c86-b7cd-34cd2d199504",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "27ccfe80-e0af-4397-8cbd-197df64f638c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9b4b6f53-091e-4c3d-9682-fb3afd7ff61d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9cf3705-f0c7-4dbb-98e4-51c51071b321",
"db_currency_id": "1987f979-a19f-4223-ac48-f97e586f63ae",
"db_language_id": "0d342efe-0d25-4ca8-9aaa-d63a2b44ece7",
"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-05-28T20:27:52.260023+00:00"
},
"modified_dateutc": "2026-05-28T20:27:52.260023+00:00"
},
"marketing_segment_id": "663408ed-fa0f-43b6-a5f6-c4bd94afc2c0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1f6eee82-9f17-498a-9019-3f227101199a",
"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": "7838ce02-239f-49bd-8433-6ab52614f11a",
"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": "65856775-ad53-4c1c-ab6f-9e6d554296fd",
"db_country_code": "sample string 28",
"feelist_id": "15eab4cc-d29e-4e1a-9345-7c3f72775d99",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d741fcbd-beb3-4765-8c26-d4223c835e17",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6ad3d5fc-e608-4557-8615-6611b3bbf2e6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-28T20:27:52.260023+00:00",
"db_currency_id": "cc885dee-166b-450e-8920-f95b2cf104e4",
"db_currency_code": "sample string 10"
},
"company_type_id": "785d4561-0cd9-446e-8be1-1ed8f939750c",
"company_type_name": "sample string 32",
"company_type": {
"id": "b6f4f022-8198-425a-b11b-d7664cde756c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "52a26ad4-30a2-4841-a02f-6a8c8afad8b1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d9a5fdbc-c8b9-497d-9531-9866fb48a041",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e70af5d9-ac78-42fe-bb6f-df4e6d053f3d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ce81a1a5-2b62-4b48-9519-74bd4cca594c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2ad97d71-e8d0-4010-818c-99c7966227c5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-28T20:27:52.260023+00:00"
},
"company_sector_id": "928374b5-40e5-4872-99d7-5832a1f34fe8",
"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": "37088fe0-4af2-4e13-9927-3a317874b7ad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3b46f6c7-67a2-4a2d-863d-a72333005263",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b0de09b5-cac1-45fa-8354-bf2256ad4792",
"account_manager_user_code": "sample string 56",
"company_status_id": "d4e528c6-afcc-427e-b536-2fcbde128280",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-28T20:27:52.260023+00:00",
"id2": 60
},
"db_language_id": "8947f272-5098-42db-bc1b-e0ad28d93a9d",
"db_language_code": "sample string 7",
"db_title_id": "15166650-5a83-40fb-b6e3-cb301a27ea1b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-28T20:27:52.260023+00:00",
"create_date": "2026-05-28T20:27:52.260023+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-05-28T20:27:52.260023+00:00"
}