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": "b4cef774-aa02-4c5d-ae0c-50918ac39813",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fd1ee072-5958-4a1d-950b-53efc8cf53f7",
"company_code": "sample string 5",
"company": {
"id": "92e2360f-ae3d-4dd9-9ba0-c599a76927fb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-30T04:43:35.5688062+00:00",
"sales_territory_id": "db65a77e-872e-49b0-b932-45ba97d7d74e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "87269b57-f8a9-4ee5-a654-4813b02e0400",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b1aab00f-acee-4c13-8556-979fc73936b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a5e498ae-8de2-42ed-8e84-71b0c1669f1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec630b96-8b50-4626-a609-1e69ef234a39",
"db_currency_id": "87f9dec3-0d08-46d5-a16d-493ef1cd134f",
"db_language_id": "78c47251-69c1-4cca-ad90-a1fdf342fea5",
"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-05-30T04:43:35.5688062+00:00"
},
"modified_dateutc": "2025-05-30T04:43:35.5688062+00:00"
},
"marketing_segment_id": "6876e0e2-3b43-413f-97b1-5eff9178aa29",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "739a3842-960a-4bd6-9928-1bc1c3785586",
"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": "040feda8-a50e-4458-b479-4847562e7c29",
"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": "7ac8a9cf-a1c2-4ac0-94ea-d23f9a12df7f",
"db_country_code": "sample string 28",
"feelist_id": "dd783b4a-ebff-4bee-9dc7-3926d838c56e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5c6b0d16-9fef-444c-95e3-32532efe5bb9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7f95a508-a66e-439e-b4ae-ede6a535eab0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-30T04:43:35.5688062+00:00",
"db_currency_id": "c8146151-c9fb-4945-8c2f-0d551a77115d",
"db_currency_code": "sample string 10"
},
"company_type_id": "243e1e8d-4348-42b6-ab78-dda3b00214c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "7dffce99-94ed-4627-8148-b2f10588c05a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "59a25908-854d-4aba-9206-5abe94717237",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fe97bdee-4847-4608-94b7-648bca03d19d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a5b9e64e-e4e3-4dc5-a154-71224b286c72",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8da1499f-5549-4f87-b6c5-5175a7def2b3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0881682c-b735-41d2-bf30-f2255a4678f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-30T04:43:35.5688062+00:00"
},
"company_sector_id": "ea4f73bc-0b53-40f9-9fc7-c81e2067d17e",
"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": "4d78c32d-a3e3-4e50-8f1c-12708279c060",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b174fe38-ebc5-4de3-8220-c1983a8b1c4d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a6b8f429-d092-41d5-969a-32107b5101a3",
"account_manager_user_code": "sample string 56",
"company_status_id": "3ef082b9-3390-4bbd-ad1d-e93f92470b96",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-30T04:43:35.5688062+00:00",
"id2": 60
},
"db_language_id": "4016cf1a-5c67-4571-ae52-40fab77e4d0b",
"db_language_code": "sample string 7",
"db_title_id": "3d498dd1-db00-4f51-8d31-a6ea0e829af2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-30T04:43:35.5688062+00:00",
"create_date": "2025-05-30T04:43:35.5688062+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-05-30T04:43:35.5688062+00:00"
}