Retrieves all the company contact
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": "ae2ac068-142f-4c0e-8150-ce8bea821a8b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "98c64e17-e050-4b0e-8223-fed980286a1e",
"company_code": "sample string 5",
"company": {
"id": "76dca343-b1d3-403e-987d-dcd62a83748b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-29T15:10:33.8333877+00:00",
"sales_territory_id": "6d7d9361-8fba-4ef5-bc10-43f68b94cb9c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "868da91f-38b5-41bf-a87a-bcbfe8dd554d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91b952cc-bfb1-4b3a-afee-0d555d8701eb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ad9e82d-037d-41ba-8216-7409fe9a2987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86eecf72-f84f-4d59-83ce-9461b7888270",
"db_currency_id": "7ec5321f-2151-4e58-82eb-d8c7ff07daac",
"db_language_id": "5509b4cf-332c-4de3-a427-bfdde4af909f",
"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-09-29T15:10:33.8333877+00:00"
},
"modified_dateutc": "2026-09-29T15:10:33.8333877+00:00"
},
"marketing_segment_id": "f4f85636-2a02-4553-8df3-4b3c9c22e875",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c8257ced-c0fb-48e4-9a26-4df8461aaef2",
"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": "83f4ba6f-1db5-4c47-9a84-d73f0fe28ac8",
"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": "4345d4fb-672a-41fd-85dc-f1cf2f7087cd",
"db_country_code": "sample string 28",
"feelist_id": "74019fa2-e257-484d-847a-b48dae991082",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f3a0a839-cc29-4e8e-9681-afdf54510020",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6d2c3f8d-5c22-4262-8ef0-086ff2e03564",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-29T15:10:33.8333877+00:00",
"db_currency_id": "eb10edfb-aaa3-4f53-b218-afa01a39415f",
"db_currency_code": "sample string 10"
},
"company_type_id": "84ae24dd-4890-478c-94c6-3082a0c457b7",
"company_type_name": "sample string 32",
"company_type": {
"id": "7d6145a3-9917-4548-a20a-6ae181308bdc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b157e97-629a-413d-bc34-9f10b4a5a000",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f4b20ce7-5906-4e10-a055-58ef8789a7d2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d9c27d71-495e-4cbc-a6d1-490f483c263d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a9618153-607d-446b-91ee-c9d6abbb3c62",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f6167e79-39af-4832-8431-bde62691de54",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-29T15:10:33.8333877+00:00"
},
"company_sector_id": "b4fbbd7f-a84e-422b-bf01-5a5873a69b68",
"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": "691c1056-ffa0-4068-b408-4cc709ddbace",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c32363b1-98b1-48b5-900c-406740fdae44",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "350404b0-a368-4d27-9fed-a246b5bbf348",
"account_manager_user_code": "sample string 56",
"company_status_id": "b3279a5d-1360-43b6-aacc-dc71d79c46e4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-29T15:10:33.8333877+00:00",
"id2": 60
},
"db_language_id": "86f9c7a4-5a7e-488e-9cc6-a56c135e31fc",
"db_language_code": "sample string 7",
"db_title_id": "c8839997-768d-49cd-91a2-16217725c9e9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-29T15:10:33.8333877+00:00",
"create_date": "2026-09-29T15:10:33.8333877+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-09-29T15:10:33.8333877+00:00"
}