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": "d05dd278-f118-42ff-882d-18459dbe8244",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "acb80867-8de9-48cb-962b-9f72d6ad19a7",
"company_code": "sample string 5",
"company": {
"id": "3ffc3bab-ce00-45a8-ad07-0650eb66c27d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-07T00:37:50.1674626+00:00",
"sales_territory_id": "44928a18-ef4a-4169-ac34-501fd6d0c84b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5766186a-96d1-4a76-beb0-6472f7429e25",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ebc0d9af-dad9-4105-8ab2-818fa417ce8f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a3519fb-129f-472c-9d80-61575a770eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9c86f728-21ae-45a6-9d0b-3a15ffb66494",
"db_currency_id": "6a74e82e-959f-4318-8560-7c45ea61ada4",
"db_language_id": "62664a26-e6a2-4fa7-bf2d-8fea5d7e5cc9",
"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-09-07T00:37:50.1674626+00:00"
},
"modified_dateutc": "2026-09-07T00:37:50.1674626+00:00"
},
"marketing_segment_id": "c51f12ae-c9a6-4d6f-a37d-ceaa89e9c44a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c9af28fd-7d30-479a-aa81-c55c9a7c843d",
"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": "14aeff57-dd1b-4d1a-8733-05954f80f242",
"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": "b83ea35b-8c99-4f1c-9e9f-746c06e676c7",
"db_country_code": "sample string 28",
"feelist_id": "6985de1e-94be-4c86-a521-e479b8fc7c70",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5a0e625b-9b5d-478c-af80-baeb89d98f8b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ed9ae626-db2c-47bb-bca5-5c325d38e7cc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-07T00:37:50.1674626+00:00",
"db_currency_id": "f94831cc-c0aa-4e79-acec-db11aad8a323",
"db_currency_code": "sample string 10"
},
"company_type_id": "f3a39b4f-a8a0-4790-a243-64059ea0699f",
"company_type_name": "sample string 32",
"company_type": {
"id": "ff45da69-815e-424c-a1bf-51059e62eefb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b634ad0-4468-4534-9192-c871cd065d0b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fc32f7a5-a584-4020-aecb-66de1805ddfb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c70d2faa-7e80-433a-90bc-24ed2cb98d48",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0bbe2385-434e-4d58-9957-60525dcdb120",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cb7ce9d4-010a-405d-9d17-44efa5d900a5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-07T00:37:50.1674626+00:00"
},
"company_sector_id": "589de3dd-4de9-4ebb-9e47-6a108f8e0834",
"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": "ba44b537-f167-4bb1-9486-f4d6d08ff4fa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "07bef10f-61b4-47f2-886e-4b34528b3e17",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e86e065a-c461-4f49-99eb-0bd4b8ffcc46",
"account_manager_user_code": "sample string 56",
"company_status_id": "4cd82549-81bd-4678-9bef-9985347e2e06",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-07T00:37:50.1674626+00:00",
"id2": 60
},
"db_language_id": "7541bd00-98aa-4bf2-a661-d268bd717eda",
"db_language_code": "sample string 7",
"db_title_id": "51013a3d-ec36-495b-9f57-efa4b7ddf7c9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-07T00:37:50.1674626+00:00",
"create_date": "2026-09-07T00:37:50.1674626+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-09-07T00:37:50.1674626+00:00"
}