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": "8ebd3020-f20a-403b-a4f4-8c068d4ff932", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "a863780c-bab7-4681-afb5-764ac4b36451", "company_code": "sample string 5", "company": { "id": "6dbc07d9-423e-41a1-9182-25ed12adbdf9", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-18T02:53:47.9885224+00:00", "sales_territory_id": "b2d51324-8175-47b0-b5a9-bf7713a64d0b", "sales_territory_code": "sample string 9", "sales_territory": { "id": "a5dc8b7e-5d38-4f3c-9ff9-197980facd30", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "c8db0b7c-efe0-4ac5-9e5a-781e67616299", "sales_organization_code": "sample string 5", "sales_organization": { "id": "b2263274-5c21-42e2-8fc4-b879cbb4f13c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "984f72ca-d3dd-45d0-9199-1107f3baef0e", "db_currency_id": "caf2e929-512b-456f-b545-19f42cb682ae", "db_language_id": "ccc76702-b956-48e0-884d-9af456f8d51c", "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-18T02:53:47.9885224+00:00" }, "modified_dateutc": "2025-07-18T02:53:47.9885224+00:00" }, "marketing_segment_id": "61eb7059-86bb-423a-95c0-492c04b75c9d", "marketing_segment_code": "sample string 11", "sales_organization_id": "8d8fb251-2385-44a9-87c7-9f063d0e75c6", "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": "2d89a80e-4433-4d2e-adf8-052948c0d8ba", "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": "ac599881-b5bf-47a4-9dd4-c8332a99b0e3", "db_country_code": "sample string 28", "feelist_id": "39c257b5-6870-4d65-8443-7c2d9afc7856", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "e7fc9335-e3f4-4149-99c2-5e4d2da34ca0", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "453ffd37-9f75-417c-af72-95aa16f038fa", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-18T02:53:47.9885224+00:00", "db_currency_id": "7ef4f52e-3781-4def-839e-77ba2de117c3", "db_currency_code": "sample string 10" }, "company_type_id": "75e64c77-30a1-47fb-a7f6-bfec81b189d9", "company_type_name": "sample string 32", "company_type": { "id": "41e8db55-87d2-4cd0-812b-3d739123cd89", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "3a131a96-5774-4352-a8d5-98390a336d9c", "sales_organization_code": "sample string 5" }, "db_language_id": "09ff1152-b0d6-4b43-8d94-1d92b8cd9ec5", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "043c62d7-6cc4-424a-af5a-280410f660ce", "article_price_label_code": "sample string 37", "db_payment_method_id": "f0a770be-d2b5-453b-a97b-64edd62683c7", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "9f81c8aa-731b-447c-a2fd-bf3e832e16de", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-18T02:53:47.9885224+00:00" }, "company_sector_id": "883093d4-b6bd-4919-86ad-426d44c439bf", "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": "cddbdc55-4ece-4da1-8744-7efc0922a688", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "3d37dcfc-295d-47e8-93e5-bac99905ed31", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "e720f6e9-34a1-4aea-9d51-58f8d3536485", "account_manager_user_code": "sample string 56", "company_status_id": "f157a74a-e1bf-477f-8868-da30d60bfb4e", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-18T02:53:47.9885224+00:00", "id2": 60 }, "db_language_id": "bfc93b18-821f-478a-9eda-2b0c74074aea", "db_language_code": "sample string 7", "db_title_id": "ec662982-684a-449c-9e91-601e2d4b2177", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-18T02:53:47.9885224+00:00", "create_date": "2025-07-18T02:53:47.9885224+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-18T02:53:47.9885224+00:00" }