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": "149f92f0-49d2-423c-89fc-7a1b69e5ac59",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e2a95402-d420-4c57-b87f-233a5fae4d50",
"company_code": "sample string 5",
"company": {
"id": "2bb55ea8-42fb-46f6-833d-aedd14e6b5dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-04T13:28:15.8999052+00:00",
"sales_territory_id": "9f3de364-71e8-4f00-a789-5dcab6522d18",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7528b770-ffd3-4371-84b3-4a40fdf5ed36",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2d934d64-db0b-42e9-af7c-80f4433c482b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8c3e7966-a8d5-4758-b9c7-5a663d447597",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "44958b5b-a3b5-4b25-8712-b66af50f4bce",
"db_currency_id": "837245d1-1bf0-440a-ad3f-3d348195f9d3",
"db_language_id": "4787dad7-696b-4c39-9241-67e9674c2513",
"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-04T13:28:15.8999052+00:00"
},
"modified_dateutc": "2025-11-04T13:28:15.8999052+00:00"
},
"marketing_segment_id": "b2187d42-4a3a-4d2d-b181-09ca7cfc325d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c0136f84-deb8-4bf0-92f5-5684dda18964",
"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": "6e7148a0-c294-4168-97dc-24875b4817bf",
"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": "1f98563e-1822-488d-9515-3e18f01670d2",
"db_country_code": "sample string 28",
"feelist_id": "82f896ca-8ebe-47f0-b47a-a30e0f8f2016",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "eff54d7c-4e1e-4ceb-aca4-5f98a98fdf92",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4278bc15-9722-426c-b859-46e423996ae3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-04T13:28:15.8999052+00:00",
"db_currency_id": "1ffa1863-2018-4c05-a060-c1e6869a0328",
"db_currency_code": "sample string 10"
},
"company_type_id": "80ea2afd-d686-4e99-a9d8-4b929c234111",
"company_type_name": "sample string 32",
"company_type": {
"id": "b0fbf46d-575f-4597-93fc-53f0378ff644",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "642db9cd-b46c-42ac-98a8-055a54b7a09e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "97907a47-21d8-4110-9f57-618ed855889b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9a72dae5-4bd1-466a-bbdc-94c848b3bf6c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "54311a5c-6ade-4ff2-b356-9b0f001e161c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "55788894-20a3-4ead-ac16-77ce48a5bbb1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-04T13:28:15.8999052+00:00"
},
"company_sector_id": "6d9823a0-6fcc-4cae-8263-54690d17897e",
"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": "91549981-49e3-48f3-bf16-b5c1a22ff6d7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3e3d3667-00fd-4195-9dcf-014ebd025139",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d07a77d6-b32b-409b-96ce-744708efdb26",
"account_manager_user_code": "sample string 56",
"company_status_id": "5121b9b2-baaf-4504-b8e9-2c5d0a337a2f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-04T13:28:15.8999052+00:00",
"id2": 60
},
"db_language_id": "d3463196-73ce-4faa-a4e5-56d07dc8c0ea",
"db_language_code": "sample string 7",
"db_title_id": "01f9efa5-75ac-4de7-808d-68329a8faf1e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-04T13:28:15.8999052+00:00",
"create_date": "2025-11-04T13:28:15.8999052+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-04T13:28:15.8999052+00:00"
}