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": "ea21c7e4-5618-4064-a6b6-b8839c8af567",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "414400cc-fe67-4ea7-befa-a8ce7373c1c1",
"company_code": "sample string 5",
"company": {
"id": "7851423b-af6c-45f0-8637-a3b71845b455",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-08T02:10:58.1805956+00:00",
"sales_territory_id": "f6492abb-0d6f-425a-840b-25a019b8e354",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c8a35e88-0961-48a7-9936-0dcb3fc55d08",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c19df1ae-0bbf-41d6-b79a-8e81fe1bcebd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "441fab81-22e6-4fe4-955d-c8ebcc88f66e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e84ed3-c300-4841-964b-b45fbcc44d22",
"db_currency_id": "3ca84ea6-507c-4f8c-a296-e04b6868f5ea",
"db_language_id": "3a9efea3-93ec-4e8d-9fc8-51227d97a192",
"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-08T02:10:58.1805956+00:00"
},
"modified_dateutc": "2026-03-08T02:10:58.1805956+00:00"
},
"marketing_segment_id": "5d7f4570-9e87-45e1-ba85-c421bcd8ab74",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "11d6e347-f8ed-41d7-881c-41d9d906c90a",
"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": "91764307-7ccd-4860-9088-f76873f2ad6a",
"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": "dea8b3ec-c884-4009-952a-6e9da11bce39",
"db_country_code": "sample string 28",
"feelist_id": "d0a28871-adad-4aa0-9936-a55f438fe66b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2ff9fb48-ba32-450a-b315-62c5e46388b4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c8041b0c-7bfb-4959-8165-a32d6e6f7246",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-08T02:10:58.1805956+00:00",
"db_currency_id": "3d1f6db4-86f4-4c39-992c-f17104fff314",
"db_currency_code": "sample string 10"
},
"company_type_id": "23c0b787-2e62-458d-8c61-53e236d2fb7b",
"company_type_name": "sample string 32",
"company_type": {
"id": "b96ad5d8-0f3d-4efe-82b2-2c1804babbfe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88fc50c7-674d-46be-a9ba-28341fab3cda",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c1d4c39c-6bd4-4403-8f1f-cfb460f9fb05",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "82351727-eef2-4501-91c2-83d3a5c39495",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "83e61afc-d88f-40ec-a39b-fbdb874745dd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f2f86a18-17d0-4127-9309-44d27c43a409",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-08T02:10:58.1805956+00:00"
},
"company_sector_id": "b94cdbe3-0bbd-4b19-aa36-c9c99b25813f",
"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": "57d171e1-3ee0-474e-a959-7b6fac71b219",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8ef116ba-c3e8-41bb-9653-8e7a6197aacf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fc1903e0-f2b7-4035-8244-be163847a5c9",
"account_manager_user_code": "sample string 56",
"company_status_id": "7704d0d0-8ae1-47ce-9963-1fb39416b650",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-08T02:10:58.1805956+00:00",
"id2": 60
},
"db_language_id": "6773839e-a622-43e4-847d-3f3a198c1ae6",
"db_language_code": "sample string 7",
"db_title_id": "e90e9bde-6ed4-467b-a466-198756033e37",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-08T02:10:58.1805956+00:00",
"create_date": "2026-03-08T02:10:58.1805956+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-08T02:10:58.1805956+00:00"
}