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": "5bf6cd21-2e29-4908-b4e6-7d49ec3e419a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "32513e75-cfa9-4d19-a3ec-c197566cf180",
"company_code": "sample string 5",
"company": {
"id": "75527336-9acb-4355-bba8-418295b69c8f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-16T13:58:43.4059084+00:00",
"sales_territory_id": "58d39126-fa79-49fa-88f7-dd13b46d2561",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "71ab0b8d-ab27-413c-b910-8279a7fbf878",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6fa3c0b2-80d4-455a-8a48-8a687ffa659b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b88e4b0a-00e3-40b9-8e15-e87b8c9763f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e51c0668-c8fb-4384-a022-c0f29bc9a7b5",
"db_currency_id": "e6113aa3-0caa-4dcd-83dc-0ac382ac4080",
"db_language_id": "8d22dc84-bb63-4a2b-a4ff-bd0259c45d63",
"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-07-16T13:58:43.4059084+00:00"
},
"modified_dateutc": "2026-07-16T13:58:43.4059084+00:00"
},
"marketing_segment_id": "f255905f-e2fb-410e-bcf9-67440aee5d75",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "27694d94-c83f-4519-96df-c866415325e9",
"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": "ce4bceeb-0db6-4eef-8785-0e91be44cbf7",
"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": "82fa4797-b8c1-4485-943c-cc2e3be2bb13",
"db_country_code": "sample string 28",
"feelist_id": "0b4a75d5-6237-40ac-8a06-c606fab33f41",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1602d4cb-91a8-4de4-9de1-45e47c05e92d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8f590c52-7737-4720-a077-ded26bdaf3d8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-16T13:58:43.4059084+00:00",
"db_currency_id": "1ee3fa48-78c0-4d65-89f6-8b79d0e54027",
"db_currency_code": "sample string 10"
},
"company_type_id": "19f8763e-70fa-4fb2-a5ae-6018ef311134",
"company_type_name": "sample string 32",
"company_type": {
"id": "10bc566c-b6b4-4416-ba04-b5537d13b343",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7ae8dd10-17b5-4810-b79c-9fbee37f736a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e9d88623-8e86-4cbc-a2d6-87d90d5b41fc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "008af844-a331-4cd3-a83e-5061fe97000f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7bd80b5c-cad5-4402-b36c-048253ff5198",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "07fed4a4-0a68-4921-bbdf-5d8c388ec1cc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-16T13:58:43.4059084+00:00"
},
"company_sector_id": "c1eecaf0-53d7-4821-ad03-ad790f172a0c",
"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": "f17610d5-77e0-4496-8ee7-a0e55475bffa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "02712720-b8bd-431a-b6f1-4171b2caaadd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f1a77bd9-058b-480b-8b40-21bca0d295ed",
"account_manager_user_code": "sample string 56",
"company_status_id": "4504423e-ecf2-4434-8b62-bb694e16683e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-16T13:58:43.4059084+00:00",
"id2": 60
},
"db_language_id": "b7341c21-e3d2-4f16-a200-9a40ed20263c",
"db_language_code": "sample string 7",
"db_title_id": "737e23ac-e5ca-4be4-805d-a18ec229dd2b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-16T13:58:43.4059084+00:00",
"create_date": "2026-07-16T13:58:43.4059084+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-07-16T13:58:43.4059084+00:00"
}