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": "9cbf66b5-4ddb-4e45-a527-5f8d521112ac",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a56053c7-c2aa-4ed7-911c-0b37967c7a23",
"company_code": "sample string 5",
"company": {
"id": "aac11c96-4980-46be-9f1d-5da5b3700c8a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T11:26:50.6782052+00:00",
"sales_territory_id": "04333372-c054-4449-93e7-713f0be72e74",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2e820d68-a97d-423a-9caf-4fc9d1f6a647",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fe326e09-510e-407e-afed-55ea066c573c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1bcb00f-a356-40f5-a259-92eb182c147a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81f31a5d-a747-4477-8859-ce4f6ddc8a5d",
"db_currency_id": "b470c584-4b3a-42db-97b6-4c2164d8d08e",
"db_language_id": "fe88165d-0966-455a-9189-8e004970ece6",
"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-06-21T11:26:50.6782052+00:00"
},
"modified_dateutc": "2025-06-21T11:26:50.6782052+00:00"
},
"marketing_segment_id": "db2fdb12-2410-473f-85c7-518736440ac4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0782243c-e40f-4e4e-8937-be45a6ca1f5f",
"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": "c8270d86-befc-4fe1-b4b8-b835f65d904c",
"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": "ea07f82f-d040-437d-8353-8a0a36ae41c5",
"db_country_code": "sample string 28",
"feelist_id": "0c5f7ad0-5d45-4da6-ad77-07003b80bbbb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "435d4702-a167-4caf-99fa-63cff9113d75",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7ea2be08-4418-45a2-b9cc-893c6d0cf94b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T11:26:50.6782052+00:00",
"db_currency_id": "b3654000-3093-415b-a2a1-db8636b02d74",
"db_currency_code": "sample string 10"
},
"company_type_id": "ea7f2aa7-56b2-4734-9a0d-5c8b5211b57c",
"company_type_name": "sample string 32",
"company_type": {
"id": "192cb227-13b8-4398-8842-8ea9a8f3cf17",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a4bf3c9-a660-4f81-9826-67947e4478a4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f41231b4-2bf5-446f-a5b1-78be30767b68",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cfead270-ef53-4e83-928d-438b4d2e8598",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0a2414f5-3435-4cc6-b7e1-d14e41ff6629",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e9c1ad8f-ff69-403b-b2fc-d4ce83f203e7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T11:26:50.6782052+00:00"
},
"company_sector_id": "346ef0c6-0f6e-4d77-a7e4-c7647b98647e",
"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": "e4f07069-ccb2-40a2-9840-56c82d9571bd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1a4c9244-365c-47de-a944-fa8da4bb87c3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fa78c33e-da7a-42f0-9842-33d3c0da873d",
"account_manager_user_code": "sample string 56",
"company_status_id": "be989106-edcf-41b7-be30-54758234dc79",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T11:26:50.6782052+00:00",
"id2": 60
},
"db_language_id": "5745c69e-8ea7-4d06-983c-639945dc8af7",
"db_language_code": "sample string 7",
"db_title_id": "0f9d41e3-f06a-4b74-b9ae-9f2f8eb00b6f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T11:26:50.6782052+00:00",
"create_date": "2025-06-21T11:26:50.6782052+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-06-21T11:26:50.6782052+00:00"
}