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": "1a773771-3520-4333-afae-faacb293de43",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8de17ac4-03dd-4c9b-8ba7-7f084d7895dd",
"company_code": "sample string 5",
"company": {
"id": "1ee7ad78-ebcc-40e7-be8d-c2bd99bad637",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-20T16:26:30.9150635+00:00",
"sales_territory_id": "fb27bf26-e3f8-45ea-b382-decc3979c1f5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1f34f4fb-7e55-4dd6-bb06-dc3e3b1f4e9c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "19dbde97-07c8-4ffb-a7f7-46f92cf8a965",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aee96079-75f6-481d-9444-f1a7e9773651",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a08cb48e-15ce-4c25-86c4-4deb258ff957",
"db_currency_id": "c372405e-f966-47c0-ad01-41811ce6df05",
"db_language_id": "207ea027-116b-480f-8862-d3cbbecebb37",
"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-03-20T16:26:30.9150635+00:00"
},
"modified_dateutc": "2026-03-20T16:26:30.9150635+00:00"
},
"marketing_segment_id": "2837d017-2b43-4695-85a9-66c6bf0d9b9a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a705aefe-4ca2-411a-b7f3-e2864afb00d9",
"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": "9d839bdb-364b-46d0-a273-34f000d038ba",
"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": "32899ae9-e2c2-497f-8667-d5c2c88ed828",
"db_country_code": "sample string 28",
"feelist_id": "c5138f1b-f84a-46a6-8ddc-7ef0fd5918b1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "46c45211-5e6e-470f-b817-a81af75c84df",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c10b267b-1dd9-4bae-9e5e-bafa02bd1cbc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-20T16:26:30.9150635+00:00",
"db_currency_id": "3a059dd5-58cb-46f7-a15c-459a5d85510a",
"db_currency_code": "sample string 10"
},
"company_type_id": "998686c9-f492-4ab5-932f-7e7e6683981c",
"company_type_name": "sample string 32",
"company_type": {
"id": "a71d73e7-c536-43c8-ac88-4a2a06f595fc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3cf597ef-fe2e-4e60-9a1a-0475f58aaa8b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ff852116-a911-4f33-9dc6-8575ff26a084",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5831899d-96a8-48d0-a23e-967111e0ae99",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "01aecd80-6e91-4186-850b-c3772a202018",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2a6865f0-98ad-411f-9b1a-c45933fb8dd3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-20T16:26:30.9150635+00:00"
},
"company_sector_id": "bd4b728e-abb0-49eb-916f-6c1ac748888f",
"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": "1c4a3c6d-7b80-438c-8bab-de97e928a33b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4b0436d3-b0a7-4f8b-bda8-7e24de16b96b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8f3eb960-e596-44e1-84ce-f8c936d3a215",
"account_manager_user_code": "sample string 56",
"company_status_id": "51705f8b-2147-4e1c-8734-667bac418004",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-20T16:26:30.9150635+00:00",
"id2": 60
},
"db_language_id": "03027647-aaa8-41e9-b3ab-c573f81e062a",
"db_language_code": "sample string 7",
"db_title_id": "39d2d718-c5e6-47ee-b6d7-912c94f42b5a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-20T16:26:30.9150635+00:00",
"create_date": "2026-03-20T16:26:30.9150635+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-03-20T16:26:30.9150635+00:00"
}