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": "02f3eb0b-bef4-469d-8be7-7a977bac3436", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "104c2841-8bde-40d8-8161-f7f32a0d6de0", "company_code": "sample string 5", "company": { "id": "798778f1-3373-4085-a049-c672e2ecb512", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-11T03:36:39.6231824+00:00", "sales_territory_id": "3220cc06-2430-4d80-9e5d-45c0d9501e34", "sales_territory_code": "sample string 9", "sales_territory": { "id": "09ed202f-1242-4d9c-84b9-0964d9c0858a", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "4cd9c9c2-0324-461a-beaf-7e89eac8f531", "sales_organization_code": "sample string 5", "sales_organization": { "id": "9f66ea3e-d20d-4238-928b-f1a749ccab7a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9845ae2c-5c93-4ca4-9994-ca8734e1f0ef", "db_currency_id": "8b1b813a-d2c2-4fd6-bfe5-5f4df35e13b2", "db_language_id": "3da6adb3-8f4c-4240-98d4-2dfc165025ef", "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-07-11T03:36:39.6231824+00:00" }, "modified_dateutc": "2025-07-11T03:36:39.6231824+00:00" }, "marketing_segment_id": "b8fd2723-5adc-4f21-9ad4-6d1919b4fa93", "marketing_segment_code": "sample string 11", "sales_organization_id": "d4530cba-3248-4b06-bda6-11c2004e9dc7", "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": "4f168995-2a73-4eb1-92ae-31c4dc7bf87b", "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": "d75ea13f-75ee-4b9b-946e-3486569a4952", "db_country_code": "sample string 28", "feelist_id": "c1b70e2f-3339-45d9-a283-46bf1a8b5e43", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "20bbb6c9-2a29-45f3-a14e-3e1520bd721a", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "e9b4ef43-11b7-4ed1-a883-f66440c7fbee", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-11T03:36:39.6231824+00:00", "db_currency_id": "e4303ada-40ac-424e-83c6-64da71d9cc28", "db_currency_code": "sample string 10" }, "company_type_id": "28562250-e797-4e5e-aa98-5034f501c16c", "company_type_name": "sample string 32", "company_type": { "id": "7065e4b3-f008-4356-96a6-5be3c0a46675", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "281b06dc-9c20-4e1d-9d06-54eabcd4e8d7", "sales_organization_code": "sample string 5" }, "db_language_id": "fdb18413-5415-4773-aef0-50def73c379f", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "0198c38f-024d-402c-b2d4-5bd966fb9d27", "article_price_label_code": "sample string 37", "db_payment_method_id": "cc06fcc6-0d9a-4070-843b-b49415b02df6", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "bab85ce9-60c9-432f-ad29-0fcd8a0c8474", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-11T03:36:39.6231824+00:00" }, "company_sector_id": "86106a28-4626-459e-b76b-b72939750698", "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": "58b9daa6-167d-4a78-95c3-ec1c4efd06a2", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "d21e3617-8141-4190-b1a9-80de2b59d7f6", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "98346911-bcea-41ef-bd2f-6df041e530ee", "account_manager_user_code": "sample string 56", "company_status_id": "3117e0f0-59ec-49e6-a43a-fdebbd6827f8", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-11T03:36:39.6231824+00:00", "id2": 60 }, "db_language_id": "1a9fec88-10d1-4cc8-b04d-ad8b080406b5", "db_language_code": "sample string 7", "db_title_id": "e5abe7ed-cdf5-42c8-9174-30b23a715002", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-11T03:36:39.6231824+00:00", "create_date": "2025-07-11T03:36:39.6231824+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-07-11T03:36:39.6231824+00:00" }