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": "4560eed2-be35-4413-958a-6626413221bb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d3512041-c591-44fa-827f-255df48f51bb",
"company_code": "sample string 5",
"company": {
"id": "3035e90b-92e9-462a-9439-a606f4a0e013",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-24T12:34:21.2301869+00:00",
"sales_territory_id": "d47f5f2f-d3a4-4223-886b-41f313d15f64",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0ba34b3c-99ae-4b61-86c8-6c3588181c69",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8da1cc07-8c12-4c39-b31c-0b8fc31f1374",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b2a0a63a-0dc0-4a07-8370-77a7c9fb517c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9aae3c13-2e53-40b7-935a-91b4841c6cae",
"db_currency_id": "909dfb5b-2e31-449e-9aa3-da2a93e1e1d1",
"db_language_id": "df930002-101c-4cbc-b236-c8fdc47e66e7",
"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-24T12:34:21.2301869+00:00"
},
"modified_dateutc": "2025-11-24T12:34:21.2301869+00:00"
},
"marketing_segment_id": "4c7bf1d4-c0c3-4792-a1bd-9ee186de515c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "beabe236-1d60-49bc-a3fb-01c48aaaccd3",
"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": "8be7d2ab-9148-4412-bfcb-bca5158c7df1",
"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": "a787907e-6791-4714-aabf-122c344bfff8",
"db_country_code": "sample string 28",
"feelist_id": "d180977e-aa04-4d26-8c6d-56ca96620cb7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8ccc2e48-50d8-4779-803d-00cdf16094fa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "adf4bffa-8e1d-407a-9ec1-016e1dbb9614",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-24T12:34:21.2301869+00:00",
"db_currency_id": "0ac18106-bf59-4a7c-8cf4-90f4399df316",
"db_currency_code": "sample string 10"
},
"company_type_id": "fdbe70c7-0e28-411f-9721-3c697925b386",
"company_type_name": "sample string 32",
"company_type": {
"id": "e7607da7-d3bd-4cf0-992c-838768ad5b8e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e0dc874-481d-4fa8-95a6-4d2cafb4db1a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "284dd87f-a059-48ce-985f-027b2d228073",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "49b68d86-1e45-4236-b449-27df1e44d6db",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1414e11e-4868-451c-a02c-5ffd64f64265",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9e3b9fbb-e844-4433-8117-fd4be9fc2302",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-24T12:34:21.2301869+00:00"
},
"company_sector_id": "cb8aed4e-3ebf-4322-ae98-fb3873624498",
"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": "0ef05968-9534-4f5a-a0fe-2e7c320f6ac6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bf970bc1-1abe-4e82-993a-5d8fa308e70e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8965e392-68c0-41f6-9fc1-2f0a1bf762d7",
"account_manager_user_code": "sample string 56",
"company_status_id": "2cd0e8c9-d230-4fd4-88be-88d2ef90c8af",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-24T12:34:21.2301869+00:00",
"id2": 60
},
"db_language_id": "4ddec72f-650c-401d-b946-72821c4ab52b",
"db_language_code": "sample string 7",
"db_title_id": "46e8b870-106a-4029-8340-401db8cc6e79",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-24T12:34:21.2301869+00:00",
"create_date": "2025-11-24T12:34:21.2301869+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-24T12:34:21.2301869+00:00"
}