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": "fc2900d8-0d69-404a-a911-9107afbbf95d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a979f0b7-a2db-483b-aafa-5ab96e7aa889",
"company_code": "sample string 5",
"company": {
"id": "e85f1318-a90d-43a9-822e-68fc34b6befa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-26T23:42:32.4213433+00:00",
"sales_territory_id": "902de7c9-919c-47fa-ba4e-188a03b1299b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ecebd7af-7ddf-4b4b-bb4f-49939a81c0bf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9e862fda-1ed1-403e-8136-c5a6752bad8e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "584c6318-f81b-415a-ad4d-80858ba0f073",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82b3950-1fa8-425a-9e43-64e5781b675e",
"db_currency_id": "d9a1ba29-6444-4754-b36a-b16d277976a4",
"db_language_id": "74e815b1-805a-4e2d-acd2-10a068891098",
"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-07-26T23:42:32.4213433+00:00"
},
"modified_dateutc": "2026-07-26T23:42:32.4213433+00:00"
},
"marketing_segment_id": "1e931332-1a76-4450-a332-679397646754",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f0ec8d29-f7ec-4d4c-98d3-3792afe8c344",
"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": "6910b6ac-d7dd-47aa-8307-1dae29142dda",
"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": "1f90e2ef-2dfe-4f58-a6d4-a71a99155fd7",
"db_country_code": "sample string 28",
"feelist_id": "1f536d5d-837f-4ed0-93c6-f3ea1d0fa59a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0a533a3f-14e7-4a15-959c-32ab45ef515f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1d770f6a-93a5-4dec-92cf-e373bfa2f972",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-26T23:42:32.4213433+00:00",
"db_currency_id": "f72151e8-4e0a-41d6-9bb0-a85cc51f33cf",
"db_currency_code": "sample string 10"
},
"company_type_id": "13a0997f-3066-41ec-91fc-d84a789a14a8",
"company_type_name": "sample string 32",
"company_type": {
"id": "9cd01e6b-95ad-40d0-8720-e97804bc1713",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ca5e98e-1d9b-45fb-ac22-390d546224fc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a38d5210-13a3-4896-88b9-d4022cc5c1b3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7b98cdd5-6473-4156-9cfd-b35857e85d24",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "066bee04-7908-4371-8465-5def71990e27",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d7ccffe3-0368-4292-8741-65304bf6e944",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-26T23:42:32.4213433+00:00"
},
"company_sector_id": "45cab88e-07d6-474c-8267-544984f3270d",
"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": "ea267fec-4dc8-4c25-860a-77e081f56790",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d5888ace-841f-42dd-b63d-5614731a48bc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4e14a928-d3c9-4385-8929-e6a4fec50373",
"account_manager_user_code": "sample string 56",
"company_status_id": "b4ae4fde-98c9-42e7-9e43-67fbeb7ce8c2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-26T23:42:32.4213433+00:00",
"id2": 60
},
"db_language_id": "e1600332-1ad4-4876-8ff0-9b2f14062454",
"db_language_code": "sample string 7",
"db_title_id": "acbe49af-b8ca-484b-8589-15a171c86d0c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-26T23:42:32.4213433+00:00",
"create_date": "2026-07-26T23:42:32.4213433+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-07-26T23:42:32.4213433+00:00"
}