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": "365061a9-5114-4de1-9b8e-cbed37dfadbc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7baf085b-b9dc-480c-ad4e-db361f3fa8f4",
"company_code": "sample string 5",
"company": {
"id": "c439c934-2b24-40aa-8be3-0ee26f0d775e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T15:27:11.752515+00:00",
"sales_territory_id": "95104706-ee9c-4c17-8494-dfe3c4112151",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a1f8041e-dee7-44e6-805e-352b2be664d6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88fc5f2c-f662-4265-a72b-e3591349ef2f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c187caf-1f1a-4813-b3bd-5356c854f8de",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a43db5f4-0355-4278-8d60-7b50b4226e46",
"db_currency_id": "c7bdc92a-7b84-4611-a49a-f7d233b0b4a2",
"db_language_id": "dade0da9-2142-478a-a37f-ea1723660c34",
"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-18T15:27:11.752515+00:00"
},
"modified_dateutc": "2025-09-18T15:27:11.752515+00:00"
},
"marketing_segment_id": "63b4f83a-d759-469a-8936-be70d1ec98b5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8c3b0ff0-d92a-4c9c-aab2-f1e443b369fb",
"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": "66bfbc88-2d89-461f-a85a-d77f5d7a86ec",
"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": "3a82a3b2-18ad-40ad-b17a-d458a47567a7",
"db_country_code": "sample string 28",
"feelist_id": "976aff2e-ef6d-4f57-aa7c-c0b44a1f8262",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b19cf19a-dba5-4d85-bc08-7a14fa07c7e4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b9ff1b31-5706-4970-9b88-ad4bf7a3202a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T15:27:11.752515+00:00",
"db_currency_id": "ef7b9ce0-adaf-49a1-8444-1f262c3e623c",
"db_currency_code": "sample string 10"
},
"company_type_id": "de7adf97-62b4-47a0-a024-2731bb0f1ad7",
"company_type_name": "sample string 32",
"company_type": {
"id": "6960f2af-21cc-48ba-af55-f1dfd765eaef",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b283e5a-384c-47ce-a05a-89b4bbf28cb9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0f98a10c-63d5-4774-9160-24d442bc7dc1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1c3e0883-733c-4a9e-8b71-5ac18c80aa53",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "69fcddeb-3538-4f71-b898-c5efab2fa21c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "52d420a9-07f6-45cc-a662-40519be0a1d3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T15:27:11.752515+00:00"
},
"company_sector_id": "65060819-943d-4f5e-a6d8-4415ecb84f0b",
"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": "cf2ab3ae-88af-4aba-816e-03526c0ce332",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4dab40d9-1159-48c3-a46a-b170dd247c68",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "59a7692a-ba8d-4a6e-847a-0364d7f29916",
"account_manager_user_code": "sample string 56",
"company_status_id": "ebace6af-c35b-44c7-a699-3c32b03b58a0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T15:27:11.752515+00:00",
"id2": 60
},
"db_language_id": "8f4d3bdc-8087-4e50-993c-119a645c1b26",
"db_language_code": "sample string 7",
"db_title_id": "6e5a4d99-aef4-4a40-aaf5-e22a83abf087",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T15:27:11.752515+00:00",
"create_date": "2025-09-18T15:27:11.752515+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-18T15:27:11.752515+00:00"
}