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": "a41b2037-2c39-45e0-a347-8b61dd9ee103",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "198ac7a6-15a1-4007-98a8-8347e4e0ca5f",
"company_code": "sample string 5",
"company": {
"id": "3a1b393b-c537-4916-9e05-ce4399c30cb9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-15T16:43:49.2472515+00:00",
"sales_territory_id": "fd4c347b-7550-41c6-8b1e-5759968f7409",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ef6b0be2-5f45-4258-963a-88a81adf265c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffb48cb7-9d2b-4b0a-ab0d-62ace333c1db",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9fa3aab0-af5f-4234-84db-988b236a869f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "013c3262-b9db-42bd-8781-d2442b2521dd",
"db_currency_id": "f693eb45-df9b-48d6-8fc3-5b14a74b44f6",
"db_language_id": "e6b11723-f00b-4ec1-9c47-368dda4597ba",
"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": "2026-08-15T16:43:49.2472515+00:00"
},
"modified_dateutc": "2026-08-15T16:43:49.2472515+00:00"
},
"marketing_segment_id": "d321feee-a8c5-48b1-a0b5-89bed19c6e4d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0964106d-130b-4927-aa1b-fb9bc94630c9",
"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": "f616c772-486d-4d01-ab68-26925ea48602",
"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": "c4a7b6ba-70c8-4077-980b-51bda855592e",
"db_country_code": "sample string 28",
"feelist_id": "5b57c374-5a2f-49b6-85e3-7ef5649ad95d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5969ee57-404d-499f-aed4-c46e4d307270",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "939e6110-eb64-4c9c-aa37-6f7253bdcdb4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-15T16:43:49.2472515+00:00",
"db_currency_id": "e41b0edd-23d4-4491-bfce-6522ddc37610",
"db_currency_code": "sample string 10"
},
"company_type_id": "34e19988-f045-4c5d-a9a7-d7c35c5a4df0",
"company_type_name": "sample string 32",
"company_type": {
"id": "ebb3b050-171d-4638-b077-3ff41d547acb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0022044b-04b4-4387-ae3e-92a27e75f448",
"sales_organization_code": "sample string 5"
},
"db_language_id": "db415bdb-09bd-4638-b6cc-4567f3d330da",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "efba9c62-42d7-445f-ae26-1a6bc8df5c75",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5fb82e87-5ada-4623-b27b-796e50dee9b8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8fdd882b-8257-43fb-9c83-34ab842e9de4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-15T16:43:49.2472515+00:00"
},
"company_sector_id": "6a4569df-4755-4f4e-9c9d-fe93b9153ff1",
"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": "b93c3fce-c21b-48bc-a8c3-03b139b99ea9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a80a0a68-e860-4bda-b7e7-611d74e77832",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ae598ecd-d30a-4270-a14e-aac35ad6b152",
"account_manager_user_code": "sample string 56",
"company_status_id": "668caf23-e586-489b-aaf9-ad2055213f43",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-15T16:43:49.2472515+00:00",
"id2": 60
},
"db_language_id": "7d96e6c5-d7f6-4518-bafb-6c80181725d8",
"db_language_code": "sample string 7",
"db_title_id": "93fa4b94-ceaf-40e9-9325-2868355f6652",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-15T16:43:49.2472515+00:00",
"create_date": "2026-08-15T16:43:49.2472515+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": "2026-08-15T16:43:49.2472515+00:00"
}