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": "b0bf5cda-12c5-4aeb-8bea-4da7dfcad1fa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1b864d88-894d-4970-8a46-294a6d402084",
"company_code": "sample string 5",
"company": {
"id": "408cbdc5-d565-4a90-bca7-33016f3c1a59",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-24T06:42:53.5500166+00:00",
"sales_territory_id": "859492e4-b5e4-4aa4-8aa9-9cd75a97ed09",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d737d993-7fec-4426-9da7-4c670d67830f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "94bbe4f2-d751-46fe-9862-7316989665e0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2e666b42-5c85-4150-bda6-a7551bc61762",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34ed3544-8209-4a62-a110-46eb75b275f6",
"db_currency_id": "6cd2026d-613b-45ae-b96c-9ef7415ce9d0",
"db_language_id": "3c494829-3583-405c-b618-3b319e67230e",
"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-10-24T06:42:53.5656365+00:00"
},
"modified_dateutc": "2025-10-24T06:42:53.5656365+00:00"
},
"marketing_segment_id": "32994942-bf9c-47fb-8dfd-80c539e39447",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5eb4b325-27d7-4e40-a487-b78cac6f6b9f",
"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": "06e831e8-6cee-4284-a9eb-17c3a5c89bd7",
"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": "10585f4e-c421-4f4f-83cf-ba3b1bf89770",
"db_country_code": "sample string 28",
"feelist_id": "392922c8-fb68-4e36-b2a0-d7ac49b1ffd1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "396ba2b8-d1a6-4b68-9d44-6ae07c20218a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d9686bb5-aaea-45e4-b317-3b56d24f92f9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-24T06:42:53.5656365+00:00",
"db_currency_id": "92ded391-0d9d-4eb7-a254-4b5bf66baf7c",
"db_currency_code": "sample string 10"
},
"company_type_id": "cfbaf3c0-cf9a-4521-a62d-3688720e0a49",
"company_type_name": "sample string 32",
"company_type": {
"id": "cc6306d3-73c5-42d4-b890-48b7455625bb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f456191f-fafc-4a65-8121-40c168a168d4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "827a6414-eb22-4926-85af-2a451af57e33",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0042fba0-9bab-415d-b422-e08677403333",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0aee47f5-3eb7-42b9-bf3a-964edacf9011",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e5e4a4fe-d99f-4d22-846e-792de3b4d866",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-24T06:42:53.5656365+00:00"
},
"company_sector_id": "1cc05927-adbb-4bfa-a138-360ee66a916b",
"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": "45b5f805-8aae-489f-8217-7d8faacd0e22",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9cea20f4-dd1e-4e7e-8e44-79c77177fa87",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f98c51a3-8708-40a8-a16c-154a2e606c42",
"account_manager_user_code": "sample string 56",
"company_status_id": "7c68863b-bac0-4e5d-a97c-ff6ef67895e6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-24T06:42:53.5656365+00:00",
"id2": 60
},
"db_language_id": "10591900-92f4-4416-be02-0ed09b74d9e2",
"db_language_code": "sample string 7",
"db_title_id": "c29a5ce9-be86-4dbc-9d80-beefd8659632",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-24T06:42:53.5656365+00:00",
"create_date": "2025-10-24T06:42:53.5656365+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-10-24T06:42:53.5656365+00:00"
}