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": "c1017036-0e5a-490a-a74b-956999352c54",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0099f4bf-6163-4462-9eb3-1cfba3b59131",
"company_code": "sample string 5",
"company": {
"id": "9fd38abe-0216-4f5b-b56a-bc6f14823952",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T21:37:20.4105332+00:00",
"sales_territory_id": "078f5f5f-ef35-45eb-a9c8-3241ff46cb98",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2ff0a8d4-4f45-43e2-9d83-e57ff7786f84",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7055bff3-13cd-4cde-8453-19127e8169b8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "646ffa47-2951-44ac-b3ad-c8fba78e0a6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04b6575e-0067-4a78-ad41-f53972f8c94d",
"db_currency_id": "8f402de9-95f6-45d2-8092-b898b73f8802",
"db_language_id": "5d25f0f6-9970-4444-9b49-6e47c48b9ee7",
"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": "2026-06-25T21:37:20.4105332+00:00"
},
"modified_dateutc": "2026-06-25T21:37:20.4105332+00:00"
},
"marketing_segment_id": "1a730eb2-63ef-4a4a-b64e-6a9729e3c432",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7a5182bc-1d8e-4cd6-8cbd-da6e8a2f707e",
"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": "3961c98d-d33f-438b-8884-50fa7f81a087",
"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": "4db5fdbc-f29d-411f-8c38-5464fa6f119a",
"db_country_code": "sample string 28",
"feelist_id": "eee5cad5-e46c-404b-ba9b-faca5877babd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "04b7ecee-ca7e-433d-acfd-a43956306588",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a6416d59-adfe-4606-9acb-b1f52863a8fc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T21:37:20.4105332+00:00",
"db_currency_id": "e72df0d0-eb1a-498c-9860-657fc86ba201",
"db_currency_code": "sample string 10"
},
"company_type_id": "0fed63e7-c245-4299-9e19-be7565d69255",
"company_type_name": "sample string 32",
"company_type": {
"id": "9542a111-18a2-4d26-b4e8-8fb0a69bd471",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a96143e-481c-4122-89ce-1179446d1d10",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e9dea617-37e8-454a-9b53-a1d5f1438f48",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2575d47a-8efd-4c2c-a853-39ae4b575a5a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2143fb2b-231c-4933-9d5c-0927e333ed23",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "41af79be-83e6-46ab-81a7-ad670455a346",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T21:37:20.4105332+00:00"
},
"company_sector_id": "6b714978-7299-4140-b557-7e9b4d90d312",
"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": "f80141cc-5c9c-47d0-b185-5594841fcc88",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7f2fb17f-b35e-4830-b2af-81ae79e357ed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c0292368-2d90-496c-ab78-bda4f7d5aa38",
"account_manager_user_code": "sample string 56",
"company_status_id": "6385daad-5cf0-4e6b-8ba4-ab33fd849535",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T21:37:20.4105332+00:00",
"id2": 60
},
"db_language_id": "0b47cec8-04b2-4a19-b9fd-9a34517defba",
"db_language_code": "sample string 7",
"db_title_id": "d6573e13-3df9-45d0-86ff-e5c4368cc412",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T21:37:20.4105332+00:00",
"create_date": "2026-06-25T21:37:20.4105332+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": "2026-06-25T21:37:20.4105332+00:00"
}