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": "10c8d8b7-b694-42a4-afe3-afdca0e6f578",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "40958372-1f7a-4bb3-bb05-b07b42e7e63e",
"company_code": "sample string 5",
"company": {
"id": "b115145d-4d5b-4b11-9233-c53173d8a8ec",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-03T08:30:36.1673715+00:00",
"sales_territory_id": "3120ba80-22c0-464c-942d-eb9733f6d456",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "da7f5008-2ffa-4b15-947c-ec3b77fc5b75",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "27bb1be5-f4f3-4737-a775-be757ece8125",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ec06552-9d8e-49d4-b8af-8ce5ed4ba14d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd418d9c-775c-4763-9be0-7889fe02e8fa",
"db_currency_id": "972a40ac-99e2-4bd8-be59-16aa9cb41dda",
"db_language_id": "b744705c-27b0-4be3-ae48-abcf4bbb7622",
"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-06-03T08:30:36.1673715+00:00"
},
"modified_dateutc": "2025-06-03T08:30:36.1673715+00:00"
},
"marketing_segment_id": "3fc68c93-0b6e-4e7d-a121-a897a2049403",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0ba1d290-21e9-478d-a1ae-7f5e79d225d3",
"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": "9f8f441a-6a44-47b6-a2a7-baf3f08a75b6",
"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": "6917aa22-1a2d-4593-a127-050aed7a9474",
"db_country_code": "sample string 28",
"feelist_id": "3073c7ba-bbdc-403c-8091-010d13644626",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f47e5bcf-2ec2-4405-bc49-56855ee46475",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "037d1950-b7d5-4403-bbe2-944748b4ac19",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-03T08:30:36.1673715+00:00",
"db_currency_id": "e1bc17bf-f45f-4b70-8c3e-4630d465bf11",
"db_currency_code": "sample string 10"
},
"company_type_id": "8fbfbc42-ebd0-444d-be6c-a8e9903aa900",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ec850d2-267e-4939-ae02-c76f9aace417",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "27a26fa7-4193-4776-9302-d8b99a87420d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fddad357-87b0-4207-8244-1042a9eff114",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d6861792-c481-495a-a944-43b770230576",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cf9b814d-ad9b-4cdc-ae45-299cbe4a1d26",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "64eb4ddf-036a-4899-b360-b9d274758a2c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-03T08:30:36.1673715+00:00"
},
"company_sector_id": "fa56592b-af2d-4598-9b2c-512b89e2fc03",
"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": "e3476793-d37c-4a49-b6e1-57aabc3e69ae",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "52f2e0c2-e84c-4537-9689-1d1bcff24e1e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ef3da610-0b5f-40cb-8c35-4d0a84ebb810",
"account_manager_user_code": "sample string 56",
"company_status_id": "1e4a117e-deed-4d62-aa7b-afa5e2f7467f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-03T08:30:36.1673715+00:00",
"id2": 60
},
"db_language_id": "77f5d861-fd7f-40cf-83cb-5cae26aa85da",
"db_language_code": "sample string 7",
"db_title_id": "1cfaef85-2157-42c1-9055-b39f5bfcce3f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-03T08:30:36.1673715+00:00",
"create_date": "2025-06-03T08:30:36.1673715+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-06-03T08:30:36.1673715+00:00"
}