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": "ac6aaaf0-d0ea-4df8-a8fd-d9c1f0e5dc04", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "e6b45622-94e7-4d18-9c9a-29edef4a9596", "company_code": "sample string 5", "company": { "id": "d6d2e9e4-5ba3-4a16-8386-34aee7696172", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-10-19T14:15:10.0363585+00:00", "sales_territory_id": "224ea327-fa2e-408c-925a-9ed37a7e7380", "sales_territory_code": "sample string 9", "sales_territory": { "id": "dcf64be0-0b1d-491b-bbf9-2171b7765f7c", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "497b6656-ec71-4c99-b939-b85d28727d21", "sales_organization_code": "sample string 5", "sales_organization": { "id": "ba822956-9d6e-4a01-a58c-a4e828784bac", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "5c50e18c-adf2-4751-8d8d-ffe93475b68f", "db_currency_id": "6b42d5c5-72a6-429f-b249-c326a77cf818", "db_language_id": "c0d52c4f-a93a-4074-84f9-46e5a6e49bbb", "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-10-19T14:15:10.0363585+00:00" }, "modified_dateutc": "2025-10-19T14:15:10.0363585+00:00" }, "marketing_segment_id": "059d4ba7-39b5-4335-bd06-930e079ddcc3", "marketing_segment_code": "sample string 11", "sales_organization_id": "7d0c15dd-2f75-402b-bfa8-8994406da954", "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": "ee1df71f-30e2-4fb6-97ff-fec0520fe4ad", "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": "63491809-ae92-4c45-b0a3-21751b1fe7d1", "db_country_code": "sample string 28", "feelist_id": "1990e170-e470-47aa-a0d1-14e1763755cc", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "609c4c4e-b0c8-4a70-bd54-33b6ec3350d7", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "14dbf8e8-b818-4224-9541-9740aa73b001", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-10-19T14:15:10.0363585+00:00", "db_currency_id": "9b609e30-32ec-4ab2-b3ef-bb4e845f0350", "db_currency_code": "sample string 10" }, "company_type_id": "81cd4585-a787-4103-a2a4-89d4b68db019", "company_type_name": "sample string 32", "company_type": { "id": "d8c67adb-26f6-4c87-b1ba-dbcfe6527df1", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "1a5d66b7-c057-41a5-82e9-1f116ed04335", "sales_organization_code": "sample string 5" }, "db_language_id": "6d6d6a2e-1f76-48b5-b44d-f6c47b91d15d", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "db7a1da9-3ba8-410a-8f5f-a4cbd36004d6", "article_price_label_code": "sample string 37", "db_payment_method_id": "09b9e6a0-8bd7-4fbc-bb99-3c9df73d4504", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "5218ed2c-3056-45e1-8a84-d12e216d9aca", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-10-19T14:15:10.0363585+00:00" }, "company_sector_id": "73ed5035-2f01-456d-949e-4cd0b302a7d5", "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": "06172db2-442b-44e8-af80-7322db9b26cb", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "f510a486-7313-46ad-bf68-79dc31ddece2", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "9cc101e8-836b-46d4-9ebc-796ba51e7423", "account_manager_user_code": "sample string 56", "company_status_id": "1eee52e3-ea7d-4968-a2a0-152281f397e6", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-10-19T14:15:10.0363585+00:00", "id2": 60 }, "db_language_id": "76142af1-3cb9-43a8-87b6-d3ff6c63d62b", "db_language_code": "sample string 7", "db_title_id": "3fdb1166-ec53-4312-9b96-2714ceb9ef63", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-10-19T14:15:10.0363585+00:00", "create_date": "2025-10-19T14:15:10.0363585+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-10-19T14:15:10.0363585+00:00" }