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": "47054386-13ae-4cd4-a9b5-aa34f3c26017",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "af173525-2204-4d3f-8b3a-95d6b2b83b81",
"company_code": "sample string 5",
"company": {
"id": "e2137ccd-3b35-47f7-b8bf-4903fd892bfa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-24T11:00:30.7214153+00:00",
"sales_territory_id": "e05ecaaa-def3-4e28-9528-28e23b02f550",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e32f9a58-bbfa-49c8-9134-c3b842be7132",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed809874-355b-451a-b145-ca2a68662bf7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "58a71bf5-e682-4546-a486-6031f8f00cec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7469af73-5e40-439f-b64b-8a0d2bc9f83e",
"db_currency_id": "5e0cbd92-8bef-409b-921f-86ee389b7f4d",
"db_language_id": "fddfaf93-cb04-4c5e-971f-793c4928f3ef",
"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-04-24T11:00:30.7370396+00:00"
},
"modified_dateutc": "2026-04-24T11:00:30.7370396+00:00"
},
"marketing_segment_id": "0583abe3-66c0-46e3-9027-658db866f769",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8649c1df-6c60-45c2-a322-8c3581bbef74",
"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": "c9c954c0-65f4-45e0-89c1-e02ad6ece880",
"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": "fd485c1a-167e-490b-b372-501bd8e81ad9",
"db_country_code": "sample string 28",
"feelist_id": "f50348b7-4e76-492d-9341-e406fb1ee563",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9c20f954-acb6-4384-942a-cb11bfee5212",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b64d35e0-b5ad-4f79-8d42-7080d4cb8910",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-24T11:00:30.7370396+00:00",
"db_currency_id": "f3c949d7-e6e4-4140-93c9-35f817165029",
"db_currency_code": "sample string 10"
},
"company_type_id": "895dd7a0-ae16-4b91-8a15-ec8f6f43f9ff",
"company_type_name": "sample string 32",
"company_type": {
"id": "1b8a9981-2772-4c61-b906-3e1f8f0d4194",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "49cb4d55-1d13-4bf9-b499-42a1d2d63926",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02749674-2492-423f-b2d4-246c87e0300f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "74076446-06c9-46be-80c0-5e1954ebbcdb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b34f34c1-91f2-4714-8f9d-7d2785594ca8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6ae0fd12-6190-48c2-a67c-3a561332bf31",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-24T11:00:30.7370396+00:00"
},
"company_sector_id": "92e7e5d6-afe9-4a63-9c45-68c8a703f169",
"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": "732abd76-1c5d-4014-9a90-d3418499a896",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fe37cdf4-6dd2-4e62-891a-638bc0f7f1b6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "06a3af9b-5a46-426a-a969-5a6863adb76f",
"account_manager_user_code": "sample string 56",
"company_status_id": "fc6c1eb4-4b50-4790-b716-230b7eb9a265",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-24T11:00:30.7370396+00:00",
"id2": 60
},
"db_language_id": "ddcdda1d-4ea6-4eb6-91b6-aca8619bc819",
"db_language_code": "sample string 7",
"db_title_id": "813659cd-00bc-468e-aaa8-527ffded7daf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-24T11:00:30.7370396+00:00",
"create_date": "2026-04-24T11:00:30.7370396+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-04-24T11:00:30.7370396+00:00"
}