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": "0a576a77-6662-479f-8e05-b685a5787435",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "00d17e0c-32cf-4be8-abc4-a554075d7401",
"company_code": "sample string 5",
"company": {
"id": "ad8e4040-c28b-4224-a5d6-46156ba9ec34",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-14T20:31:27.0460866+00:00",
"sales_territory_id": "cfa3955b-25b0-483a-a550-4de2454be6ce",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f74c049a-6ae7-45a4-8a75-16eb3ca0a1a6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "781b2efd-345f-49b1-9f39-426ac469bcbe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f654eeec-3947-430b-a1a5-082bee8ae873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbd09283-2b30-4cfc-849a-b2d930225646",
"db_currency_id": "99d79ea1-df62-4fbe-990f-da341286af12",
"db_language_id": "f1967165-4ea3-44eb-8f34-09e6573d9830",
"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-05-14T20:31:27.0460866+00:00"
},
"modified_dateutc": "2026-05-14T20:31:27.0460866+00:00"
},
"marketing_segment_id": "0746abb6-2b2e-4e5d-873a-13906532179c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "10fee3af-4f78-4aa5-923d-d86a4ea472c5",
"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": "61fb4493-a683-4d1a-914d-8b3a0399a8d9",
"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": "ab850d25-fbef-4666-883f-e59845d056b4",
"db_country_code": "sample string 28",
"feelist_id": "b46fff38-e6e8-4b32-8331-658789170ba2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9dea74f9-7ae1-46b2-8982-efc54a8fd12f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "90676384-8353-4ee4-95d7-1162777d2588",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-14T20:31:27.0460866+00:00",
"db_currency_id": "6e9bc143-31fa-4743-bf05-d1d43e95b364",
"db_currency_code": "sample string 10"
},
"company_type_id": "c50ecee9-168d-4c41-9a17-a18825567190",
"company_type_name": "sample string 32",
"company_type": {
"id": "dcb69bf1-27f0-47bf-bfc5-be615ff14346",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "762346af-dd21-443d-b088-a328af262ba7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7cbdaac1-b648-41e8-8113-1c740a22ec5f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2e88da05-5f60-4475-90bf-a7f87af89560",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "80014fcf-ae60-4507-95d2-ce324ab248e5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "107d71d9-d4e3-41a3-adeb-2004ca3d0666",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-14T20:31:27.0460866+00:00"
},
"company_sector_id": "e718f349-fb67-450c-8e99-9273544db24f",
"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": "5775ee52-3176-4f11-a41b-e3e7d75091bb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9e4a3f7d-0b18-485f-801e-f4f1e384bbad",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0ebdd75a-86e7-465a-831c-8574b3054630",
"account_manager_user_code": "sample string 56",
"company_status_id": "134356ac-68e8-445b-acd6-3284a433906d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-14T20:31:27.0460866+00:00",
"id2": 60
},
"db_language_id": "f86fc8a7-6766-4106-a0f4-63c5400a30d9",
"db_language_code": "sample string 7",
"db_title_id": "5d27faed-f4f2-4789-9fc4-2f864d8ba794",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-14T20:31:27.0460866+00:00",
"create_date": "2026-05-14T20:31:27.0460866+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-05-14T20:31:27.0460866+00:00"
}