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": "555e246c-8eb8-42a7-8a58-ccd2e78fba27",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "98e6ca9b-a007-4134-80a3-4ea578bd413c",
"company_code": "sample string 5",
"company": {
"id": "1f58e010-b0bb-490d-9c05-f44a467d970f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-10T05:32:58.3975505+00:00",
"sales_territory_id": "45a6cb70-fae5-4d70-bcb9-5c378c4704c6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ec82e7b8-d2b6-4374-a047-f4e3a440362b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c601194c-9129-4e7f-bc52-8e67b6604675",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b0629307-4d14-4c69-aea8-f2388eb2507c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c621ea95-7224-4a81-a667-6d262b32c6eb",
"db_currency_id": "b89c7b21-e13a-4640-8c61-251e541e63b4",
"db_language_id": "70efdc8f-7306-48c6-926f-636803771742",
"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-11-10T05:32:58.3975505+00:00"
},
"modified_dateutc": "2025-11-10T05:32:58.3975505+00:00"
},
"marketing_segment_id": "53567b11-0a3d-428a-a70e-2e08b90142d7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3d1feccb-9649-4e04-9e66-7f546546749f",
"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": "b76cd3f8-6df5-4dbb-9f94-0602e4f9be11",
"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": "c4d661e3-f60b-4424-a1e3-a76a2a4db52c",
"db_country_code": "sample string 28",
"feelist_id": "aff2f640-0e8f-4597-8512-58fce4b16de5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f7476a27-e15e-44b5-801e-d00a9dda2979",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e335833a-9da8-43e2-80c9-0911401481aa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-10T05:32:58.3975505+00:00",
"db_currency_id": "2e5d56ff-2ea9-46d0-9431-7941771192c9",
"db_currency_code": "sample string 10"
},
"company_type_id": "2d797714-c47c-4d33-87b7-936045e87d21",
"company_type_name": "sample string 32",
"company_type": {
"id": "f24f4f3e-c80d-4d4b-b248-bdcd9c95eeeb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c5c37a3e-a516-4051-b9f3-a539e08669b4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ec5d753e-644d-4b5e-aef5-205f59fde2ab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fe0daa85-b97c-45c4-ad3c-e95f127b6850",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "76099c71-f081-498b-aab0-7693f8d66a6b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "08f14cc4-4440-413f-abb6-e68ca41c5ee0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-10T05:32:58.3975505+00:00"
},
"company_sector_id": "47832043-2cf2-4fe4-9bea-4e00e45ef33f",
"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": "cdfec0c0-9813-4952-9362-e74a90ba46c3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4d84bb6e-2ec7-49d2-9d34-552481830da1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "aa5d27d5-4bef-4954-909e-332d5f57179b",
"account_manager_user_code": "sample string 56",
"company_status_id": "76538d0c-4167-4c5e-9d2f-a113c4b591b3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-10T05:32:58.3975505+00:00",
"id2": 60
},
"db_language_id": "e252db97-7e84-4b9b-ba1a-57d10553b15f",
"db_language_code": "sample string 7",
"db_title_id": "005de3a7-03d0-4c57-96d1-5793fef1f495",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-10T05:32:58.3975505+00:00",
"create_date": "2025-11-10T05:32:58.3975505+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-11-10T05:32:58.3975505+00:00"
}