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": "633a87f1-6809-45bb-a8c4-be83e4a2fd6d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "456edb87-9c2a-4ea8-b0eb-fb63f477cae6",
"company_code": "sample string 5",
"company": {
"id": "a2c5c4dc-713d-451e-9c93-d6718af845c8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-07T23:41:12.2727024+00:00",
"sales_territory_id": "7a55b481-1085-4cf7-961b-0187c5470a8e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "82a14211-6792-4802-bddc-561126d997db",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2208f15b-3b1e-4a18-b6e8-9e63c0be2c33",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a3b2ea77-0104-420e-9ef9-9feffaa39b19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47501b5-ad42-4a18-aed6-8710a8be0551",
"db_currency_id": "4f484058-899c-470a-a8eb-e15252741c9d",
"db_language_id": "69281943-5533-4307-9549-fe50b187f5b1",
"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-06-07T23:41:12.2727024+00:00"
},
"modified_dateutc": "2025-06-07T23:41:12.2727024+00:00"
},
"marketing_segment_id": "ac2e9d6c-816d-4f60-9f30-d1c6f5802f3f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bcbc0b7d-89b6-4e9b-b91b-ea3ae8f7aba6",
"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": "0a0e482e-f4e0-4093-88cf-fa074534a83a",
"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": "3cd218f3-6ade-4a44-8eb0-a3e460fff1c3",
"db_country_code": "sample string 28",
"feelist_id": "2c808ff8-b13c-4873-a751-c48aa727ca33",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "88f60d51-e840-4832-9fa8-5c701ffd60de",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d2bf7771-5501-4285-9708-ad63b5478e2a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-07T23:41:12.2727024+00:00",
"db_currency_id": "5bb47a0e-5c10-4745-82c6-0f7f3aaed99b",
"db_currency_code": "sample string 10"
},
"company_type_id": "e358d956-ae66-4305-8045-dee753568a7f",
"company_type_name": "sample string 32",
"company_type": {
"id": "c2db4142-dbb0-4fb1-ad71-ed6a4e68fb57",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b39d829-54a4-4955-853c-25929a209ed1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f324a92a-74b6-4ed9-8321-312e80d6f35a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2c9dc138-d1e0-4523-9063-9eb0f8b6235e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c876ad43-1fa7-42d2-878e-2561bb8d9a1e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6d49fe22-a162-493d-83cf-1642ffe0af9b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-07T23:41:12.2727024+00:00"
},
"company_sector_id": "4d985bdb-c581-4bdd-821f-a0ab679b92b9",
"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": "ad3d202b-7797-4522-9447-5845310069c0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c41c6c4b-1599-4799-b5e2-ac85a1d5f479",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b194f135-4db3-43a6-9fa9-779aaf5d30cb",
"account_manager_user_code": "sample string 56",
"company_status_id": "a03f1f71-e3ef-4a7b-80ab-4339cf0644bd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-07T23:41:12.2727024+00:00",
"id2": 60
},
"db_language_id": "0b792b62-d95f-4a0a-bab2-39f23a914c27",
"db_language_code": "sample string 7",
"db_title_id": "d68a3c9f-647f-473a-8d11-439ec7035bba",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-07T23:41:12.2727024+00:00",
"create_date": "2025-06-07T23:41:12.2727024+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-06-07T23:41:12.2727024+00:00"
}