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": "48eb6ac5-680c-426b-93c2-7dd30081fd07",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0075eef6-2386-478a-9b87-e1b1bf4670df",
"company_code": "sample string 5",
"company": {
"id": "87e35bc6-2c6b-447a-8d9f-d925d281e700",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-15T12:03:30.6394256+00:00",
"sales_territory_id": "a0ec5b32-189a-43be-88df-42fc23a40664",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bfdcadb8-be7b-474a-adf9-d3bd2dddfb5c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "98cda6f2-7b8b-4aca-99af-6195490b42e8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef995445-2d4c-4167-9d9d-8cc94dc153c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ba6df8bb-5c11-4754-820c-b0a9243e5dc4",
"db_currency_id": "540a893f-b6f4-416f-a5ba-659425eed7b6",
"db_language_id": "b8ff653a-3b30-4bfc-86fe-fef8c59c9113",
"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-15T12:03:30.6394256+00:00"
},
"modified_dateutc": "2025-11-15T12:03:30.6394256+00:00"
},
"marketing_segment_id": "92793320-d4e9-42d1-ba79-013829d053f2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "96964020-b8de-4cf0-a52f-750900dd119c",
"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": "df80633a-1e51-4a86-a9c1-d8237a99f295",
"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": "9d1f9ed9-9e5b-492b-939e-e28ceb8e6a66",
"db_country_code": "sample string 28",
"feelist_id": "8933d7d3-80c5-4ae1-b615-ab4d0ea937ee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "49591d8a-89d3-474f-94ad-dac75e79e685",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "015ccb47-7149-4194-b2d7-d7b513d51276",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-15T12:03:30.6394256+00:00",
"db_currency_id": "6d8852fc-aa71-444f-9bde-63116c857661",
"db_currency_code": "sample string 10"
},
"company_type_id": "f3edc9c2-e019-470f-8299-19f4e927973e",
"company_type_name": "sample string 32",
"company_type": {
"id": "1eb858a8-37a0-4aed-8c6c-c1e3d05bc317",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9f175582-7d3b-48bd-adbb-e47f52cc62be",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b3fe9ec6-1650-4a8c-aefc-9df297adb88d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "07709028-9156-4926-b3b2-a3c5f32a6f8c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7a58bb51-e547-4bc3-a469-3f4a184036be",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7e5b85bf-5fbd-4c75-a783-3be57d513c84",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-15T12:03:30.6394256+00:00"
},
"company_sector_id": "1bea5988-cfb6-4a37-8c13-f9b3f77cb8fe",
"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": "3d8d9ed2-42de-49f2-b4fb-4c9d3afcc4ca",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fc1e1c8d-c8eb-4020-a3fc-422aade382c5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "45919c0e-2df8-448d-939e-0cfa802eef66",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ed06350-0d4d-418c-940c-3b9fcb44b202",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-15T12:03:30.6394256+00:00",
"id2": 60
},
"db_language_id": "6a80431e-0c60-432d-a30e-941e28ec2f99",
"db_language_code": "sample string 7",
"db_title_id": "9cfd6140-b1c5-4fea-99c8-ff3272872693",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-15T12:03:30.6394256+00:00",
"create_date": "2025-11-15T12:03:30.6394256+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-15T12:03:30.6394256+00:00"
}