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": "4e5e7877-f9dd-40cd-95e6-a31a05488794",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "36955a22-0270-4a39-9506-c2e53915bddf",
"company_code": "sample string 5",
"company": {
"id": "827824f9-8af8-4da8-ba49-279abeacea43",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-03T23:53:53.7582752+00:00",
"sales_territory_id": "233931ed-a47f-4873-9705-90fbb83ce62a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e04699eb-1f1c-477e-b3d4-16f46cf737f4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d92b7c84-adc1-4e1a-bf05-44d7e1464fa6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "235f6155-90f4-44ea-9de6-a647ef4e98b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fec5aec-e771-4061-9e84-a6718639f9cc",
"db_currency_id": "cca13f7f-a9e7-4646-960c-b503e8f25876",
"db_language_id": "34896d90-af29-4e8a-91b7-8a8695056bfc",
"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-09-03T23:53:53.7582752+00:00"
},
"modified_dateutc": "2026-09-03T23:53:53.7582752+00:00"
},
"marketing_segment_id": "b03844d7-0ac5-41c6-9f7d-8436e07e63cd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6542c1ec-00e3-433a-ada5-f58f69ef6653",
"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": "cceb9e51-9ff8-4a6e-9ad3-09f5a89ebf27",
"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": "cc00f6b2-3229-4c5d-896a-0970845027b6",
"db_country_code": "sample string 28",
"feelist_id": "aa043f0f-b090-452b-8b5f-f343dbe910e3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7203ae88-7efe-479b-86dd-f9d9d9700a5c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "38d9dd45-6611-4cc4-8a2f-606e6d4f39ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-03T23:53:53.7582752+00:00",
"db_currency_id": "6d5066ca-5427-446b-b6c7-5368b2cb57ce",
"db_currency_code": "sample string 10"
},
"company_type_id": "5def8868-a129-454e-9ac5-29f25f9e1414",
"company_type_name": "sample string 32",
"company_type": {
"id": "96fc4593-5c42-4e6f-894d-6c394785309a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e3d46dc5-1c64-4b7f-81c0-170b2b273bc0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0f348cd4-3012-4bea-976a-9e4c85d17676",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e2243924-a542-4ac0-82bf-8893b57dc085",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0e438bb5-7608-4ca5-ac4d-a93d913603e2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8f509aaa-4f9c-4f1b-837a-57a9dbfb96d9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-03T23:53:53.7582752+00:00"
},
"company_sector_id": "295b181f-c7bd-46ad-8517-78f5e5ea9d04",
"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": "f71441cf-e088-4189-8812-6464db43be98",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "81018f84-d3e7-48f2-b955-7dadfe861bbd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1f4a4312-54cc-4763-9e45-412641d85fee",
"account_manager_user_code": "sample string 56",
"company_status_id": "0969e344-0f03-4f41-b2fa-56ef0394c3c8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-03T23:53:53.7582752+00:00",
"id2": 60
},
"db_language_id": "3e69b950-37b9-444f-9983-a53f4125a1e7",
"db_language_code": "sample string 7",
"db_title_id": "21875739-0355-4895-a80c-1fe7636ecbb7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-03T23:53:53.7582752+00:00",
"create_date": "2026-09-03T23:53:53.7582752+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-09-03T23:53:53.7582752+00:00"
}