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": "0478f7db-bdea-4eb3-ac0c-48fb8eea7203",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0f56003a-de9d-4148-8275-f2d503be44c9",
"company_code": "sample string 5",
"company": {
"id": "8a7d7aea-fd7e-4e9e-bba2-fce7ad03ffa8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-16T23:52:22.9616665+00:00",
"sales_territory_id": "52f0985e-6581-447a-b78b-5e56d999e966",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "76c104a0-b498-4db2-a63e-41749f9d4e39",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a0749c17-0373-417f-991f-34ba59e7111f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a49c1444-972a-4f93-85ef-861478730974",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1213be7b-1a17-478d-8fcb-7a06b62de150",
"db_currency_id": "e2fab837-3563-4b58-8d24-3e1fb571df8a",
"db_language_id": "427c59ed-7b55-485a-af9c-d5a21b647465",
"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-12-16T23:52:22.9772899+00:00"
},
"modified_dateutc": "2025-12-16T23:52:22.9772899+00:00"
},
"marketing_segment_id": "ec1b8997-9790-40db-8ba3-dc323501fa48",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "42722847-0d41-4b6a-af6d-fc0694756cf8",
"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": "d3407986-01fe-41bf-b3f2-bea9db600df4",
"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": "1a8fa73d-73f4-45f8-8a13-e9a05b662b82",
"db_country_code": "sample string 28",
"feelist_id": "207a5f18-aea8-48c3-b1df-68f89ada48f9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "42929c2b-6a40-4aa3-bd75-3ad6992d3b58",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4ba58419-f7ed-43df-bbdd-49189fc5579b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-16T23:52:22.9772899+00:00",
"db_currency_id": "d360c021-38ca-47d3-a63d-fd6adbf8bfce",
"db_currency_code": "sample string 10"
},
"company_type_id": "de8c1376-77e0-4f38-9f8f-cb7ad2da3012",
"company_type_name": "sample string 32",
"company_type": {
"id": "241284f7-2482-4c06-ad99-1efc4f27b141",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6b93024c-574d-4f1c-a9de-7c7ea2ce80d5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5c1ffad4-da1f-42e4-967e-6242e5bbb6bb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4a515a35-a9e7-48ac-ae6a-c89b77713ec7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0fbd8eb2-990d-466e-9284-cae251165b26",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d08e8197-c9b6-43d3-83b8-b8e4437dd154",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-16T23:52:22.9772899+00:00"
},
"company_sector_id": "6114de64-68fc-4f4a-8e45-6dbea6ea51d1",
"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": "38e1d12c-9890-4b8c-ab30-9fdf45b6339e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7d8f1b04-4117-4268-a0a6-53e0fe6fbe22",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2e21b349-f958-4458-b13b-ff04bf1965b6",
"account_manager_user_code": "sample string 56",
"company_status_id": "1d5c5d36-c6f3-404d-b015-e7592281110d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-16T23:52:22.9772899+00:00",
"id2": 60
},
"db_language_id": "27d4589a-e061-46d6-ae07-7a46f281770b",
"db_language_code": "sample string 7",
"db_title_id": "8b3d902b-99ac-4866-8c92-b4335a863461",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-16T23:52:22.9772899+00:00",
"create_date": "2025-12-16T23:52:22.9772899+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-12-16T23:52:22.9772899+00:00"
}