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": "2de772a4-e0e7-48e3-a2e7-54031d15bf40",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "04f1ffea-96d5-4db6-a4fc-d2d4832cb6c2",
"company_code": "sample string 5",
"company": {
"id": "2122ca96-364d-4097-b749-d8e0dd7e49cf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T00:27:52.1533038+00:00",
"sales_territory_id": "c893088d-a348-4f5e-b7c8-b822a5e6d5dd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "761fbbd5-c0e1-4c79-92a4-7abee7d53cdc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "279c6a16-4904-4687-82d7-d11f6436971d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "80717fd7-ea20-499d-8b0e-8839d992f9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fb77da-4835-488c-ac56-3aaf960eb083",
"db_currency_id": "283e2ab3-df3e-4f75-b40f-e5edef1f7104",
"db_language_id": "9bff220b-cc83-4ce2-805f-991dc098e3b8",
"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-08-10T00:27:52.1533038+00:00"
},
"modified_dateutc": "2026-08-10T00:27:52.1533038+00:00"
},
"marketing_segment_id": "1bc8944f-2d26-4770-94bc-24df2d78c67e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8d95bbd9-f509-452c-9bee-6e0655350e46",
"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": "e6b3317e-ffaf-4b75-8a35-0da5544a7dad",
"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": "419d2269-0cf9-4556-aef1-4f1d3f4fb431",
"db_country_code": "sample string 28",
"feelist_id": "184cbd6d-891b-4605-aa4d-6acad267d931",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2cb747e0-1933-4360-9ceb-d81826980bfe",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e0279846-9c68-4491-82e9-9079d0f98a5e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T00:27:52.1533038+00:00",
"db_currency_id": "34899551-0879-4ebb-8f75-7762fc039858",
"db_currency_code": "sample string 10"
},
"company_type_id": "dc56c4d7-452f-478b-bdb6-af88bdd281b2",
"company_type_name": "sample string 32",
"company_type": {
"id": "91a08994-e227-4a97-bba3-e5100d5f7255",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "39deb4f7-5cd0-4a49-986b-04c9c47e6a77",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d9d9a82a-732c-4074-9f3b-7c9fd203646e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5de8061e-eee0-41fb-a551-a403e8e8ba69",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "500789cf-e3a9-4b46-b3b7-930d32d22ae2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "38387ead-1e4a-4029-a4fa-6ec67f8ac03e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T00:27:52.1533038+00:00"
},
"company_sector_id": "c4688578-dbd2-4265-bde1-78729283a20d",
"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": "4a41ab26-b7be-42dd-bf70-f6be83e276d4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7141450c-8d0d-4f1b-95af-fac351a80b9f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "01233962-692e-401f-af88-966c9ebece39",
"account_manager_user_code": "sample string 56",
"company_status_id": "6874dce0-98e1-4d41-9064-a983f1bf41b2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T00:27:52.1533038+00:00",
"id2": 60
},
"db_language_id": "54a0e515-aa88-4c04-a39b-ab42bd349e72",
"db_language_code": "sample string 7",
"db_title_id": "ef9d2710-6662-4855-b4f1-ab7d1abfe39e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T00:27:52.1533038+00:00",
"create_date": "2026-08-10T00:27:52.1533038+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-08-10T00:27:52.1533038+00:00"
}