Retrieves all the contacts
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contactName | 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
{ "id": "dd3fbb24-8d76-4ceb-96bf-dbb20f73897a", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "3e5bd0a4-8b62-4b3b-b03f-de8431e726e7", "company_code": "sample string 5", "company": { "id": "1b1abec7-5095-46c0-af27-d9fb9b0a29c1", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-02-18T04:00:03.9938483+00:00", "sales_territory_id": "f6c10bc1-58ad-4f0b-9b53-3fb0b5b77369", "sales_territory_code": "sample string 9", "sales_territory": { "id": "decd0e1d-06d3-433f-99c4-9de03cea6596", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "570348ba-8c49-4050-98e0-5bf77144b6e8", "sales_organization_code": "sample string 5", "sales_organization": { "id": "263dbf44-8213-499b-9f83-270d7d53ac92", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1cad52b5-027a-4f67-920c-f4218a086bb0", "db_currency_id": "5f649bde-48d4-4d90-a7eb-74a4170c4975", "db_language_id": "4d6eec60-26fa-450b-9069-2f58dfabcc40", "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-02-18T04:00:03.9938483+00:00" }, "modified_dateutc": "2025-02-18T04:00:03.9938483+00:00" }, "marketing_segment_id": "e98aa865-1f77-492c-9765-31d121dc6b6c", "marketing_segment_code": "sample string 11", "sales_organization_id": "dda4af95-33af-430c-84a3-02c2274fb1cb", "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": "8382700e-f1e7-4e01-9597-8a6790597bd9", "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": "2f394b98-df41-43b5-b3c4-f1a151515c96", "db_country_code": "sample string 28", "feelist_id": "2e522428-cd6d-426d-b73a-de7fbcb512ee", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "ba0f8f54-224d-4d03-908a-83d92e03fabf", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "31d6b959-0355-46f5-9129-a0d68257d4e8", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-02-18T04:00:03.9938483+00:00", "db_currency_id": "9b26cc5a-4582-42c8-949e-0f6eb41707c0", "db_currency_code": "sample string 10" }, "company_type_id": "e935f215-75f0-4d82-81f0-4bb18d58f4ac", "company_type_name": "sample string 32", "company_type": { "id": "17f2e188-1fce-4924-9f06-9783c288a3e7", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "ec36bd70-46ca-4acf-a247-f2c342974fd1", "sales_organization_code": "sample string 5" }, "db_language_id": "40908472-e5a7-4a1f-baad-6f69785067d7", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "51084931-3e69-4bd1-9721-78ca0674662d", "article_price_label_code": "sample string 37", "db_payment_method_id": "e85fb416-2c40-4913-b204-9b698c727db6", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "512f0c47-aaf3-46f5-bf93-cea0043d49aa", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-02-18T04:00:04.0094736+00:00" }, "company_sector_id": "f05dda1b-22e5-48b6-8fc7-cc09c83c325c", "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": "c3644ee3-5743-4270-89a3-7f94996dca01", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "97caf4fa-00b4-44bd-9362-eaf38f5f810b", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "0db33fbf-d753-4bc0-869b-75cd64db7397", "account_manager_user_code": "sample string 56", "company_status_id": "d063929c-f39b-44b9-ade0-35ea78a14148", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-02-18T04:00:04.0094736+00:00", "id2": 60 }, "db_language_id": "94f59e1e-fb4d-4856-b8a2-a2a9bf9d2f7a", "db_language_code": "sample string 7", "db_title_id": "a4f90a62-ee59-4f27-9e46-1d0db83336ba", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-02-18T04:00:04.0094736+00:00", "create_date": "2025-02-18T04:00:04.0094736+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-02-18T04:00:04.0094736+00:00" }