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": "b5c5840a-8575-47a6-82d9-f8ac0c30e140",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8e0e43c8-0777-4f05-989c-8d2040a54102",
"company_code": "sample string 5",
"company": {
"id": "55ac0b3c-593d-482b-a832-e52cf566948d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-19T01:06:41.6372326+00:00",
"sales_territory_id": "c94d50d5-0c4e-4feb-adbe-0a0db14ab3d7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5ee7c6cb-d86c-472b-abbb-cb1e22778883",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffc3aa79-1c84-4e20-95b5-410a53b3a0fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3269adfe-a1dd-4a52-b7c5-145373bbc8b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d388081-f5e5-46cb-9fbc-a5b1be1383fb",
"db_currency_id": "764b0b4a-3659-4c3f-96ff-be21cabe0163",
"db_language_id": "cd962497-978e-4448-8ab5-ad8cc2dbdfc7",
"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-19T01:06:41.6372326+00:00"
},
"modified_dateutc": "2026-07-19T01:06:41.6372326+00:00"
},
"marketing_segment_id": "81f2a330-72af-4f78-9960-f38e04086c5f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0ef33779-28c0-4fe0-b197-641058ae9b1a",
"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": "e2d30814-4866-4319-9710-eeb34b307957",
"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": "5bbb3504-2967-4d3c-917b-f193bde6c50e",
"db_country_code": "sample string 28",
"feelist_id": "93298047-fb92-4e07-9894-1fb723fc189a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0e0e8e3c-46c3-43a0-ae18-a2fd7f218244",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c0c47dea-bbdc-475b-9e5f-0552ce83efd1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-19T01:06:41.6372326+00:00",
"db_currency_id": "0c469f7e-6efc-4eca-8e3e-f26ddbeee415",
"db_currency_code": "sample string 10"
},
"company_type_id": "3c278907-f361-4ca3-998c-3e608c5cfc40",
"company_type_name": "sample string 32",
"company_type": {
"id": "54fef77b-7683-4523-beac-c09c48478d2f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6ec384c3-f39f-41d3-9093-9a9edaea7135",
"sales_organization_code": "sample string 5"
},
"db_language_id": "68fb6720-5a3d-43cd-8e84-95ee9644a7a1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e5921b9d-7733-4382-a6ad-5ef723e66904",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3d750154-55f8-4c88-936d-3da8cba97a36",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b408b04e-df60-447e-8b17-a5e30f86ed31",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-19T01:06:41.6372326+00:00"
},
"company_sector_id": "bc628600-9ad0-45cb-9431-680312ff5ea6",
"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": "3d87b21d-42da-4357-888b-e978aee8d40c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8c1bb869-d9a7-440f-8049-3995fb175be1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "13e0c305-6311-4017-ba21-e5e064a24f36",
"account_manager_user_code": "sample string 56",
"company_status_id": "a26e4fbc-a7ef-4236-bafe-4afef322da02",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-19T01:06:41.6372326+00:00",
"id2": 60
},
"db_language_id": "4fffd8f5-f584-4077-a1e9-cf51b6d05936",
"db_language_code": "sample string 7",
"db_title_id": "448c139e-7c90-4c9e-85ec-ffb02743a1f9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-19T01:06:41.6372326+00:00",
"create_date": "2026-07-19T01:06:41.6372326+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-19T01:06:41.6372326+00:00"
}