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": "19531118-4e60-44ca-b5ef-5e379b1eeeb8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1054091f-c6b4-49a6-8ed1-15f0b438e5ca",
"company_code": "sample string 5",
"company": {
"id": "2813ae5b-1040-4c1a-841f-da0f39ed1a31",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-03T06:22:34.9931267+00:00",
"sales_territory_id": "cc0d5425-30f8-4453-8232-a6cb4029d2c3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5227f9c4-eb31-436e-a5b1-6748ceccf9ce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b92a4f92-1995-4929-9c9a-9fc4240c5a11",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8aa5dc3e-f2fb-4bbf-8d2e-91150b52829d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b1d4072f-8397-41d8-850b-abd0b086e3c5",
"db_currency_id": "822f73b1-e649-4008-99f4-efd981847bea",
"db_language_id": "6a7a88a4-fa6e-46f9-9a79-f8a79c35cf74",
"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": "2025-09-03T06:22:34.9931267+00:00"
},
"modified_dateutc": "2025-09-03T06:22:34.9931267+00:00"
},
"marketing_segment_id": "44802a7f-1bd5-406e-a883-613d0e85f10e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "88550e37-39e8-4a9b-a7f5-f32c2bc34328",
"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": "57841322-6c2f-488a-8f3f-e4b46e0b0a96",
"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": "8009e12c-3a27-4c3d-9af5-87d1cfe63da0",
"db_country_code": "sample string 28",
"feelist_id": "fc5fb6f5-8794-433c-8473-12c901e131c2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "34f4c4be-b16b-4b5c-ad35-53dd6d719d8e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "96b8dfc3-722f-43a2-97c4-625ca41d385c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-03T06:22:34.9931267+00:00",
"db_currency_id": "23b917be-7e4f-435c-8176-b00e783f4f9e",
"db_currency_code": "sample string 10"
},
"company_type_id": "d25a8c5e-dfb5-4d7c-ab89-bd9fc68e2003",
"company_type_name": "sample string 32",
"company_type": {
"id": "2d6bf278-1067-474f-8ec8-be1a8174b849",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2425e84a-d63b-4da8-9d79-18f88536086d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d5a91ac4-e2fa-4f0b-baf1-221c73ff8f5c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2a7da746-874a-4e15-a6c2-772eeaf65dc9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "35298ee7-13a0-446e-9cb5-2b7d3ed025a2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "32f22e78-000e-4727-89e9-7092b041eed6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-03T06:22:34.9931267+00:00"
},
"company_sector_id": "52cd155e-58e6-41e5-bbbb-5f6a09f3266d",
"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": "64ab06d0-c777-4bfd-92f7-d792d74eda7d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a67e005c-4fe3-4462-81c6-90a3d66dd94d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ed0c80c6-e2b9-4c96-94eb-677a22eabf4a",
"account_manager_user_code": "sample string 56",
"company_status_id": "b2a868d8-0f59-49fc-beae-a4739e68ad97",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-03T06:22:34.9931267+00:00",
"id2": 60
},
"db_language_id": "dad14b46-99f7-457d-8b77-bdfb83e9ab9f",
"db_language_code": "sample string 7",
"db_title_id": "c1ebfdd8-5961-4fc0-9e0f-c85027101311",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-03T06:22:34.9931267+00:00",
"create_date": "2025-09-03T06:22:34.9931267+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": "2025-09-03T06:22:34.9931267+00:00"
}