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": "8219afb4-92f7-427e-b8ca-da89e2e03665",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "660a739c-54d9-4d21-85c0-6766c3f628ad",
"company_code": "sample string 5",
"company": {
"id": "1d7719e1-37e5-43b7-a516-aa73bfe36086",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-15T20:47:32.2700836+00:00",
"sales_territory_id": "115f79fc-ef56-44a5-926e-eb4f7bcb1b66",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "50ca7784-e35f-4907-871b-53d1e072f28a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3e7a5c37-d8a8-43c0-b9c0-1afed43eefe8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a310b2a3-382f-49ca-9565-523677ef3119",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e2e1dba-26b5-4e84-9285-a3da266cd09e",
"db_currency_id": "a2280d10-b5e5-429e-8dbd-0d98babe9aa3",
"db_language_id": "3fe4b554-4bb2-4ec8-abf7-363ff6c02bd6",
"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-07-15T20:47:32.2700836+00:00"
},
"modified_dateutc": "2025-07-15T20:47:32.2700836+00:00"
},
"marketing_segment_id": "cbc1e0a7-919e-4f26-855a-0d01f80b3d02",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "658317e3-8002-4f03-a691-b317c26fd3b5",
"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": "24505118-420e-4508-938b-491c659edebd",
"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": "e373fb39-6243-4612-b059-8e7129d86a05",
"db_country_code": "sample string 28",
"feelist_id": "a1aef0c6-5ac8-4037-9f43-3ab050044745",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b37ae2eb-c14e-4175-8336-360100c9a7f2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "40faf050-ddf6-4f2c-9685-97a183473059",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-15T20:47:32.2700836+00:00",
"db_currency_id": "97a258a6-3810-4fb0-aa89-c92cc0e341f4",
"db_currency_code": "sample string 10"
},
"company_type_id": "492e7213-06a7-4947-bbf4-df1d857ef5c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "00f54df9-a8ab-4e1f-83d7-e577f9cdf08f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd37ea6c-2aaa-4a24-8b12-5d9fa90f16ae",
"sales_organization_code": "sample string 5"
},
"db_language_id": "727815ab-14d4-4157-aeb8-c95b249ccfe8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0817d25c-342e-4bc8-ad8e-ec4c71ba9c78",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "70256eb1-ef16-4bd4-9fc7-b80380a63e11",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7d4d307c-b7d8-4cc8-9dbc-4b882ee27f64",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-15T20:47:32.2857662+00:00"
},
"company_sector_id": "41babce1-2462-4292-8c48-7a399665f249",
"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": "cfe15046-2aaa-46ef-a648-fb3a56deaf7b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b84b8c70-9771-4975-8911-1cf5c5bd9f38",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ef4755f1-c152-42f0-8f51-d4314563e994",
"account_manager_user_code": "sample string 56",
"company_status_id": "89e1033f-e2c6-480d-b5f0-06d857601d45",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-15T20:47:32.2857662+00:00",
"id2": 60
},
"db_language_id": "6619bbf6-4303-4451-90bf-7081bde25973",
"db_language_code": "sample string 7",
"db_title_id": "5da2b07c-5dcc-4ac6-b947-8deadbae4d0b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-15T20:47:32.2857662+00:00",
"create_date": "2025-07-15T20:47:32.2857662+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-07-15T20:47:32.2857662+00:00"
}