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": "ddb0a99b-eee7-40b7-834c-d1ae04479923",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "553a28ec-68fb-4138-8f17-51305a853d2c",
"company_code": "sample string 5",
"company": {
"id": "504f43a4-e8b8-41d3-a415-53885c717508",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-19T22:58:28.5159159+00:00",
"sales_territory_id": "fd28b92e-5139-452f-82db-c4a3778f942d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1ac01b34-151a-47ab-9444-781e389c1c87",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c5996ace-1809-4320-9ad3-79cf514556bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e32dc6f9-575b-41fb-a885-7ede2d5788e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef80ee1-548c-4ba5-889d-ca2a98ce8b49",
"db_currency_id": "ce1faa06-5ee9-4c6d-bfb2-ea2da6b0024a",
"db_language_id": "97cd72cd-c504-4c15-8048-b888dfe50f8c",
"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-10-19T22:58:28.5159159+00:00"
},
"modified_dateutc": "2025-10-19T22:58:28.5159159+00:00"
},
"marketing_segment_id": "c168083b-ce32-446f-87c4-3bd09fa67fd6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a8a9c234-a05d-4eb2-8fc2-bb68be4f371d",
"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": "47bfead8-e6a7-4dcc-b49d-1ddf03eae190",
"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": "95fa8e44-8987-4211-acee-7aceececfd2d",
"db_country_code": "sample string 28",
"feelist_id": "a0461076-289a-4252-a6a9-a06ffe656ae6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "18c59d8e-1b44-47cb-adee-57380f778f89",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "977a5918-45cc-494e-8cad-3ce10b8a06d1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-19T22:58:28.5159159+00:00",
"db_currency_id": "d6c9c7b3-7b55-469a-bf46-e45888552627",
"db_currency_code": "sample string 10"
},
"company_type_id": "99cfc3cd-37f2-40b4-8268-e8a4a2908378",
"company_type_name": "sample string 32",
"company_type": {
"id": "b5cf43e6-2eee-44a4-888b-194ed703e9f9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "44d119ff-3daa-454a-a4bb-63479a7abd44",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aac7e2db-d55d-432e-ac9c-f1073df04735",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0742ddb8-83ff-415d-8207-7e9d2f01b51d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c360fb41-6637-4b03-a676-bf2e566d6b66",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f45e9b3c-b701-450f-b074-7b798864299b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-19T22:58:28.5159159+00:00"
},
"company_sector_id": "44dddf70-5e80-494d-8114-effe0b00604f",
"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": "945d77d2-284f-45ec-b6a8-f2bd2653592d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4698c86c-31f1-4b7c-adb1-990c350aea52",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1a1784b4-b181-47cc-a82a-ed24e754543d",
"account_manager_user_code": "sample string 56",
"company_status_id": "a28f8062-a0e7-4f20-be4d-3d3b58d6fdf4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-19T22:58:28.5159159+00:00",
"id2": 60
},
"db_language_id": "051f9fdc-2d09-43f6-9d27-c0dbdb5ee6b2",
"db_language_code": "sample string 7",
"db_title_id": "e5f8cb88-386b-4852-ac76-260be6a3b068",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-19T22:58:28.5159159+00:00",
"create_date": "2025-10-19T22:58:28.5159159+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-10-19T22:58:28.5159159+00:00"
}