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": "6adaeb7d-c79e-4977-a68e-840c3a40d15b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "053193d3-519e-41fe-b2ab-15f427234d81",
"company_code": "sample string 5",
"company": {
"id": "dd0f0e8b-40fc-40b7-85bf-4729849fdf3c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T12:47:54.4313761+00:00",
"sales_territory_id": "8430d826-6092-47a7-9b3e-383ca42fbc3c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1c806fd1-ea72-4bdb-b9bd-c79521b1b41a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b390a773-bf05-47c4-8a4f-2136d05becac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b206061e-2cd9-46e8-b751-b2c18604223a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aaa2e08-2331-483d-8c10-90c78cee946d",
"db_currency_id": "60d4f28d-2e38-453c-97be-9b43f41dff58",
"db_language_id": "99cf391b-6a1c-4177-8c6e-39efd009b1ac",
"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-08-12T12:47:54.4313761+00:00"
},
"modified_dateutc": "2025-08-12T12:47:54.4313761+00:00"
},
"marketing_segment_id": "96e3194a-1cda-4dbc-acee-314752532980",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "40f6fc23-5c8b-415d-bc33-d5ea403413d8",
"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": "354a6f3d-1da4-4e95-aa51-806ea53f8054",
"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": "d9b35539-731c-43a1-ad5c-bfbb7c3881c5",
"db_country_code": "sample string 28",
"feelist_id": "98d8f354-1953-4dc4-963e-2d70b5e96b55",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a2aaceb8-37f6-47b8-92c8-e0c4d49581ee",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "64cbc48d-2882-4e6f-a085-33b5b653989d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T12:47:54.4313761+00:00",
"db_currency_id": "baca2595-47a3-4f6f-aabb-9457d2e7c991",
"db_currency_code": "sample string 10"
},
"company_type_id": "99bfb0b6-1dc5-4a8b-88f6-29e0722a2b42",
"company_type_name": "sample string 32",
"company_type": {
"id": "40514b43-f99f-4a93-9506-570f13e76829",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a2ce0a38-1493-4685-a1c0-575a1bc43960",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e3d5cebf-8fe6-4111-988d-17f0f0257961",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b80d4830-43b9-412d-8ff3-cb3353a0cdb0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "96967dc7-ec2e-4bc3-933e-aa96fa868138",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7485ed0f-7927-43ba-b808-dae623924a0b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T12:47:54.4313761+00:00"
},
"company_sector_id": "0496351a-9119-4fb0-8a3b-facf56369773",
"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": "4b556627-b16d-4a95-94e1-cdbc62cb8071",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9930f174-b2e5-4361-a9ac-2843d1c8467e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0eedd308-6610-4a16-b408-271c55b44289",
"account_manager_user_code": "sample string 56",
"company_status_id": "af0e5478-86fa-4c0a-9f8e-4e775b9a215a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T12:47:54.4313761+00:00",
"id2": 60
},
"db_language_id": "3ac4da63-8282-4e75-b7d7-611c95048f27",
"db_language_code": "sample string 7",
"db_title_id": "4d666d97-5826-4f4c-8de8-d9258aca67c7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T12:47:54.4313761+00:00",
"create_date": "2025-08-12T12:47:54.4313761+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-08-12T12:47:54.4313761+00:00"
}