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": "5200b688-da2c-4368-b7ce-6ad60fbed6cd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "727d68e9-5596-4506-b0b1-0185a087e648",
"company_code": "sample string 5",
"company": {
"id": "72facbad-402c-409b-a43e-dbc34dd795e0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-10T09:03:56.7387338+00:00",
"sales_territory_id": "3885875f-26be-49c3-9333-cdc8e807f049",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6d33eeed-be8d-47ae-9ca6-f989cd9a17d4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "72cf7bff-399c-4d2f-bc4f-d4c3b945897f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d4d7ceec-b8ec-4f27-ae51-841a3df73519",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e619aa57-d706-4666-a82e-9f849f8e77eb",
"db_currency_id": "48afd819-8842-4704-8e5b-8f13628e9afe",
"db_language_id": "0ee9a904-2a7a-40a7-99cb-4b5336d2799c",
"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-10T09:03:56.7387338+00:00"
},
"modified_dateutc": "2026-06-10T09:03:56.7387338+00:00"
},
"marketing_segment_id": "8288d779-6c80-4820-b199-c7f9ab73f1b2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d0c13667-9943-445a-a1e3-7a7cb65f2cf0",
"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": "3d7c955e-f750-49e8-b9b1-b4e521b0abad",
"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": "36a362df-f4f0-43cc-8408-6416a421ce7e",
"db_country_code": "sample string 28",
"feelist_id": "848b01b3-56af-49de-96f9-3ee8166586d5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bc356665-15a6-4a4b-a03f-ca68973b4d02",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d1090a11-50bf-46e4-a2db-c1e886c2746e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-10T09:03:56.7543574+00:00",
"db_currency_id": "a30aefd7-6831-4c90-8760-8b2ec1d0ad5d",
"db_currency_code": "sample string 10"
},
"company_type_id": "3de9ecba-4198-47cd-a99a-23a6de9fb066",
"company_type_name": "sample string 32",
"company_type": {
"id": "6e362c83-17d2-4398-9400-031803461f8e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0cda9820-8a56-4dd0-a95e-36039cfe2fa9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6a08f769-2b33-45c4-80d7-d0d32eb7cc74",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "55eb9bee-5c5b-4fd6-9621-7572019ad289",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "783f2440-0dc4-4e6a-910d-fb66701dd2d6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1bd02a93-0296-445b-8cc4-385d5871c242",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-10T09:03:56.7543574+00:00"
},
"company_sector_id": "0c660f43-fcd7-4a5d-b5d6-d1127acb84af",
"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": "5d67b1fb-37a2-4a72-b72c-75c82c819899",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "96307c10-a129-4e87-a7ad-6b11814ac5ab",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b1ffa0f7-f3cd-4c5f-b286-d482f027d388",
"account_manager_user_code": "sample string 56",
"company_status_id": "07b90591-b425-45ef-beec-dd627668371b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-10T09:03:56.7543574+00:00",
"id2": 60
},
"db_language_id": "41084843-a62b-4caf-9dbc-c8037196dc3c",
"db_language_code": "sample string 7",
"db_title_id": "7ee17bae-b78a-4d31-ac01-f9cdc38a8986",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-10T09:03:56.7543574+00:00",
"create_date": "2026-06-10T09:03:56.7543574+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-10T09:03:56.7543574+00:00"
}