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": "7b63db37-753b-4053-a81b-ee1c349a2743",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9727eca1-94f3-4376-bf7c-57c5ce961f8d",
"company_code": "sample string 5",
"company": {
"id": "f3ea5e42-52e1-47f6-ac80-c67b02e9cc87",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-27T23:17:02.1042044+00:00",
"sales_territory_id": "d237d274-5a4b-4f6f-8b5c-1574c4fe582c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "529146cd-e496-4cd4-a46d-c5dfa8c5cf44",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8bf91eba-dd5f-40f7-a72b-bd08b0adb8f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "347c19f1-023d-4104-bb2a-927ed61ef2d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f4d97ab-704e-4306-89f7-b07bc4845a91",
"db_currency_id": "b2db41bc-fae8-447e-bbac-0ee260d853e7",
"db_language_id": "30c9985d-a383-4099-9765-bc225b78c1f1",
"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": "2025-06-27T23:17:02.1042044+00:00"
},
"modified_dateutc": "2025-06-27T23:17:02.1042044+00:00"
},
"marketing_segment_id": "b2e982b2-dd8b-47a2-8f57-813437bf9e3f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6a56f4e3-e741-49c5-b481-9672300a2040",
"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": "0addb0d7-4abb-4088-8fbc-6bd51c63d275",
"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": "14e9e87e-53e1-418a-a05a-ed5c917317d0",
"db_country_code": "sample string 28",
"feelist_id": "685e0afc-608e-45e1-ab0f-43a94c579afb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3617828c-9287-401c-971d-c69754d0e2f2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "33435972-8834-497d-80cf-f553998553ae",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-27T23:17:02.1042044+00:00",
"db_currency_id": "e0c07cde-1886-4d4d-b6cd-634ea6e4812f",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2ba8b71-5c4f-4297-8ca2-037e4bd92b8d",
"company_type_name": "sample string 32",
"company_type": {
"id": "e581eecf-76d3-41e0-86ba-75dda7f4a904",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3de73633-27c2-47f8-95c9-b9ab1e20c677",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2915abaf-44b3-4e26-9a30-abb8c1b6601a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aecc8baf-5c73-4588-867e-f7afd015fbef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "111d836d-8b63-4619-af57-ff26ed2c3d08",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "be854b33-414e-42eb-8ce3-99410be7def7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-27T23:17:02.1042044+00:00"
},
"company_sector_id": "b2b2a758-a41e-48c9-9e9a-8217933ba385",
"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": "333e2f52-8591-492d-8f6e-30c75a2d6ca7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "52409247-4d60-4b33-b258-157e8e91cd8f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "14d73767-2946-472e-aecf-1f584e5d02dd",
"account_manager_user_code": "sample string 56",
"company_status_id": "973d7f21-a211-4658-89ba-3e904d64e80b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-27T23:17:02.1042044+00:00",
"id2": 60
},
"db_language_id": "9843ddcd-9c83-4984-8da7-1d920d50fb0c",
"db_language_code": "sample string 7",
"db_title_id": "7f4c6683-79a5-47c5-8399-c746f2dbdbb9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-27T23:17:02.1042044+00:00",
"create_date": "2025-06-27T23:17:02.1042044+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": "2025-06-27T23:17:02.1042044+00:00"
}