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": "10f60fa1-fab2-498a-8bd0-3841c121d196",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "92563318-1510-41db-8b71-8aa8b8bc7b6f",
"company_code": "sample string 5",
"company": {
"id": "ac374ffd-325b-49cb-ac11-90cddcf08f6c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-28T06:05:31.2313294+00:00",
"sales_territory_id": "bb0b768e-bef4-4c63-97af-29a793796fcd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b1c1889e-cb25-4c2e-bb2c-d4ad154f45ba",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f701f59b-6bd8-48af-bc7a-2c2e553b1c88",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a7f3057a-73c2-494c-bdf7-97cac00c5e1b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fcade7d-35d9-4f9d-9cac-d2ee6ba41584",
"db_currency_id": "0644bbfe-f89a-49eb-903b-998573043f31",
"db_language_id": "3cbc7cda-989b-4a1e-9f0f-f6caa7314a65",
"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-11-28T06:05:31.2313294+00:00"
},
"modified_dateutc": "2025-11-28T06:05:31.2313294+00:00"
},
"marketing_segment_id": "46e3613b-4b28-415c-b34e-22014e6668c3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cc3fae8c-eb63-4fe1-a93e-3aea99e218dc",
"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": "66db12a0-0dff-4c4e-af27-c6cf3281ccf3",
"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": "3c59706c-edd8-46ed-98b2-ab8b85c14e37",
"db_country_code": "sample string 28",
"feelist_id": "63e0bafe-2840-4264-8066-4e92ff9228f9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d7ad89a3-646b-4ee5-bd6b-cccf091f5660",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bb8ccb20-84a8-4070-8cda-b8a3652e58e2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-28T06:05:31.2313294+00:00",
"db_currency_id": "0b9f5382-586b-4b0e-b592-6e2288655a3c",
"db_currency_code": "sample string 10"
},
"company_type_id": "5fe4384a-0a0c-4e8a-8ac9-40f87d6897f0",
"company_type_name": "sample string 32",
"company_type": {
"id": "f00902d2-cdc0-41ed-b964-a612eab89a5d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9eeb24d1-0f34-4b44-a5b3-d699bcc2280f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f3335502-3c56-4a6f-b20a-99471deb8bc1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "04472317-83d8-4b77-9a1b-01a0d491a237",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7e528fe0-88f3-4aff-b164-caaf845bc3d6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9290186d-a5ff-42b5-9b29-32ee588f9fac",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-28T06:05:31.2313294+00:00"
},
"company_sector_id": "878b1653-cbe4-481a-9661-da121fc038dd",
"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": "90393515-715d-450b-8925-831a8983f899",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "908cc00c-3c1d-4dcc-95c1-a0e10ddcbdd5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5c4e18e0-6bfd-4cce-ab06-17556656fa62",
"account_manager_user_code": "sample string 56",
"company_status_id": "69d4d2a9-916d-48e9-9ee7-d00f1f18703e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-28T06:05:31.2313294+00:00",
"id2": 60
},
"db_language_id": "d17abae9-51e6-4b43-b3f2-5f6666f92cda",
"db_language_code": "sample string 7",
"db_title_id": "50048dc5-06e2-4266-85d6-33e25225deed",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-28T06:05:31.2313294+00:00",
"create_date": "2025-11-28T06:05:31.2313294+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-11-28T06:05:31.2313294+00:00"
}