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": "518b6620-bafe-43cb-b77e-1d6205dcd4fa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d6efde10-e69f-4514-b6a7-8ba839b6faa8",
"company_code": "sample string 5",
"company": {
"id": "f485d119-f233-418c-a2d9-47e18ba68ec6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-07T22:44:25.2504202+00:00",
"sales_territory_id": "b3bd7b37-0200-438e-995b-220ce307e1a0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9a261b22-df24-4f93-9940-1b0fec4b1f9f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "433ff5f0-a73d-4aee-a9ff-f56f2fe2f2f5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2a8a5fe9-fe42-427f-8171-5e256be86c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f93969a-48c1-46ce-b78e-b0bfcac98dc4",
"db_currency_id": "012dc6ab-a08f-482a-9d16-041821bc5ab3",
"db_language_id": "3ebf086a-0477-464b-b293-c3c808367a19",
"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-03-07T22:44:25.2504202+00:00"
},
"modified_dateutc": "2026-03-07T22:44:25.2504202+00:00"
},
"marketing_segment_id": "67e92727-5ab1-43ab-9f41-5b8f08f7aab9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0f0deb6c-b6ef-4aba-a734-653187c4d9b4",
"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": "87162042-55ac-41a5-9dec-2f5d3dbc1d67",
"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": "2873d4e4-6000-4795-adb6-34f8fb76548e",
"db_country_code": "sample string 28",
"feelist_id": "7112806d-037e-4a13-824a-eb4deb5b1443",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "986c5b62-be38-433a-8820-0d86db26fa45",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b74556e1-38b9-491e-934f-40ade9ddbd8e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-07T22:44:25.2504202+00:00",
"db_currency_id": "65de5988-7648-4479-a6db-969ff91c80aa",
"db_currency_code": "sample string 10"
},
"company_type_id": "96ccbcd2-f448-4db0-aac5-0a82f32f2af4",
"company_type_name": "sample string 32",
"company_type": {
"id": "a0fe6d1e-dc92-461c-af94-dd14e1d06a4f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "23bc63fb-67b3-48d2-ad53-99e86a57b5f4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2efa445c-7fbf-4dbd-9ed6-1aad13453ea8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "714ef67b-947d-4377-a783-12331d7b00bb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cb8223d8-363f-4e10-8255-885dd229d187",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "96e05503-ee06-4b52-81c1-59e80525c4be",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-07T22:44:25.2504202+00:00"
},
"company_sector_id": "274cd579-4f2c-4ac6-8866-2298991e0c40",
"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": "8c6d0e7b-1c30-41b0-87a2-a9d5c638ad87",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "deed7488-3cb5-4505-9297-e18b7de07935",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d577510b-5643-4982-8f99-6232a8d9c2f4",
"account_manager_user_code": "sample string 56",
"company_status_id": "36a943b8-3637-465f-8c1a-54530a43219d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-07T22:44:25.2504202+00:00",
"id2": 60
},
"db_language_id": "fda38987-a6b5-48d6-a816-c689fddf7eaa",
"db_language_code": "sample string 7",
"db_title_id": "7f4338c1-1112-49b1-97b8-65ff41f466d6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-07T22:44:25.2504202+00:00",
"create_date": "2026-03-07T22:44:25.2504202+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-03-07T22:44:25.2504202+00:00"
}