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": "68979f78-f69a-4445-864f-cabf20634484",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "69f6eb8f-390b-4ae3-8b46-22a667456c0c",
"company_code": "sample string 5",
"company": {
"id": "6b38b3ac-2c87-4bda-a707-7792f25a7d35",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-02T12:46:57.8603535+00:00",
"sales_territory_id": "842f7927-ad7c-4373-94c6-32adaeff23d9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3a5cbe6c-a9d1-4d6d-b07c-b986756b13a3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9563b465-7941-4c75-93f6-4bac0496434b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6871043b-7ba3-4946-812f-108d11bdf612",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e79c6d9f-854d-4b84-bf6b-85ffb16babad",
"db_currency_id": "3eb41d47-da62-4526-be41-ffd35fdd9c3f",
"db_language_id": "3b4c3fa0-0586-44f4-83c4-bfd2a65df113",
"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-01-02T12:46:57.8603535+00:00"
},
"modified_dateutc": "2025-01-02T12:46:57.8603535+00:00"
},
"marketing_segment_id": "a4c21f93-438e-4b35-9b93-f88f040e4ffe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d65b2308-1d32-4429-afd1-475bc340a2ef",
"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": "3530514b-8383-4437-9a60-7c262de85e90",
"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": "25350175-d12c-4e42-9b25-35fcae66733a",
"db_country_code": "sample string 28",
"feelist_id": "c1fc5684-308a-4050-ba20-3e5814c8e32b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c6e25c03-77bd-43aa-ada9-97c0f283e01b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4efa9add-c57e-4d4a-b509-77d9b9f0b257",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-02T12:46:57.8603535+00:00",
"db_currency_id": "390127d2-6adf-4f71-a70e-b25411dfe262",
"db_currency_code": "sample string 10"
},
"company_type_id": "99be5bd6-d3cf-4dc3-9968-c4a41c82d241",
"company_type_name": "sample string 32",
"company_type": {
"id": "7e56aad8-8684-4d5f-84cd-26d0a9c1ea2c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "84e36c5b-3fb6-4762-bfba-055eefaa2829",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bc827201-7312-46ce-8018-60d595f10365",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0829beeb-c915-4a7e-b046-a087cbace8bc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7ac0403a-05b1-4b1a-9f15-ef6fbd222424",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c4e78607-11a9-403e-9e3d-6a9d6192dc2b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-02T12:46:57.8603535+00:00"
},
"company_sector_id": "b66d89c4-5893-4c4f-9e18-3bc6fac929a2",
"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": "d06203ef-2ddf-461a-87cd-334d819d8998",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5e10c094-84d3-4ac8-911c-4217e5eebe10",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8d49cc4a-61dc-436b-8360-37d54e697d9b",
"account_manager_user_code": "sample string 56",
"company_status_id": "2b01b341-5d5f-4ade-a820-cafaa97afc58",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-02T12:46:57.8603535+00:00",
"id2": 60
},
"db_language_id": "d2ad1ecd-ba9e-4770-9eca-48d5f96c3e5e",
"db_language_code": "sample string 7",
"db_title_id": "2f92f8ef-52e0-4f4e-b513-5475b74e16ec",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-02T12:46:57.8603535+00:00",
"create_date": "2025-01-02T12:46:57.8603535+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-01-02T12:46:57.8603535+00:00"
}