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": "e3876276-b389-4dab-9d1b-04f5fb1beace",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bcace444-06cd-4e77-8e93-c90ca5b3f912",
"company_code": "sample string 5",
"company": {
"id": "c0ba8ecf-ae38-4ee8-a61b-65c788de8730",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T11:29:57.7820924+00:00",
"sales_territory_id": "0d568525-460c-44f7-a877-f9a7de3293f1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d49609e6-d289-4b21-b24e-8f841d69637f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9fa05ec4-45fe-4ff6-b3b1-5b754c4fbaf8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "af7c8049-9e3b-4f5e-b3d2-18aec8e14479",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3f9c3a-3c6c-45cf-a137-e64d97fa8080",
"db_currency_id": "c65ba2c7-d537-4cc2-9b89-eb382033feee",
"db_language_id": "ebcface9-9d65-46a7-87db-7c4d8cf7aa8a",
"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-17T11:29:57.7820924+00:00"
},
"modified_dateutc": "2025-11-17T11:29:57.7820924+00:00"
},
"marketing_segment_id": "4fe50a62-9843-48f3-85a5-10065007c6b7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9bdf8aff-e8f8-43b2-b90c-180e21a8ce5f",
"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": "7bfc7b88-01bd-4b55-b90c-699176e76822",
"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": "0fbdcbb6-3404-4e3b-95fb-0fd187fff244",
"db_country_code": "sample string 28",
"feelist_id": "5e9d989c-c69b-4eb4-84f1-6e50b7aa8749",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "81862451-aed1-4b6e-9390-3df469269c99",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b0934221-8e69-4ceb-a93f-3e46284c8b96",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T11:29:57.7820924+00:00",
"db_currency_id": "43337cea-e682-4afb-8539-c957b45a4ded",
"db_currency_code": "sample string 10"
},
"company_type_id": "27dc5188-e48d-4dc0-8b2b-5176c8745c17",
"company_type_name": "sample string 32",
"company_type": {
"id": "58dbba44-ae2f-47aa-b523-ba4054eed0f8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5d0a1334-d36e-4dbf-aec6-1637ddce3432",
"sales_organization_code": "sample string 5"
},
"db_language_id": "21f4e9c6-a5a9-477f-93af-c3c3e50b3d7d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f7239518-d997-4156-b4cd-6e77c4290d9f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9752c6ff-72fa-44fd-a879-b8d3b3e9d237",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "19e40807-e3c1-41b7-8fb1-ef653c129219",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T11:29:57.7820924+00:00"
},
"company_sector_id": "c5ab5e78-4995-4a66-b66f-a12da10f17cc",
"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": "242058ba-62b7-437b-b1ec-614b17840370",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "56fc8c48-977d-449b-b921-350f1bc85d3c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2a3dfff9-6264-4efa-8d4b-b3642fbc0081",
"account_manager_user_code": "sample string 56",
"company_status_id": "3bab864a-bfd4-4f6f-9bca-cc8217a3257f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T11:29:57.7820924+00:00",
"id2": 60
},
"db_language_id": "e87ad1ab-e0a4-452b-a28c-fc96b339fee7",
"db_language_code": "sample string 7",
"db_title_id": "e7cf4ff8-7e09-4c4c-9960-1cbec5ebd571",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T11:29:57.7820924+00:00",
"create_date": "2025-11-17T11:29:57.7820924+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-17T11:29:57.7820924+00:00"
}