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": "f18cb1fa-afe9-4894-ba81-bfd32f5b4143",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f7533f1c-fc5c-47d9-bc07-b0cd76d6f282",
"company_code": "sample string 5",
"company": {
"id": "bc018635-a1da-4bb2-9bc9-ceedc42cd7c1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-08T05:06:39.2411139+00:00",
"sales_territory_id": "a95950fd-e7d5-4d36-a546-895b67cb72e2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a5a282a2-cf80-4cbb-89e6-d364c1bdeb76",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f2298c51-c271-454e-ad20-69fb2ef09b9e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "72e8d2df-bd33-41e1-ab0c-6c2fc242432a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "528aaf0f-99be-4ca2-b074-0c94eb0ddeda",
"db_currency_id": "3d06e62c-a1fb-4e28-9efa-4e2e6294198e",
"db_language_id": "a5706740-cc89-4968-9c76-ba9d3ba1f28e",
"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-07-08T05:06:39.2411139+00:00"
},
"modified_dateutc": "2025-07-08T05:06:39.2411139+00:00"
},
"marketing_segment_id": "f91dcb2a-ca84-4312-8eb0-29187a10fef9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "329704ef-3208-4445-9102-59196bf89a40",
"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": "0ca41432-6310-4b47-9015-aff55b277a9d",
"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": "11b60b8b-0fe3-4676-8ab5-901ada715254",
"db_country_code": "sample string 28",
"feelist_id": "2199df28-d081-49a1-a94a-d505c51d3b2d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cfdfc9c3-f0bf-4474-8261-d94e3f8b016a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b89eb66d-8890-4689-b907-50b66fc31079",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-08T05:06:39.2411139+00:00",
"db_currency_id": "3fd3873d-0f4d-4696-9a2e-954e88983c50",
"db_currency_code": "sample string 10"
},
"company_type_id": "64f1eb64-0655-4bb2-a9d5-823485b78cfd",
"company_type_name": "sample string 32",
"company_type": {
"id": "371f3263-6a87-4663-a02e-0505187324f3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a474cbb6-c395-47d0-8a70-d5c1c01490ec",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9781abb7-c919-4967-9a3e-b9c11903f5c9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "465baab2-ad35-42cd-b768-6abc04a676c9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0d08d0ac-2231-4216-acaa-2be13c749fb8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c0d5bf84-cf88-49c2-a5fb-9da577a91bd3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-08T05:06:39.2411139+00:00"
},
"company_sector_id": "21ad49d5-9644-4410-9eda-8b1ab3414f38",
"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": "81700d83-0e22-48d3-9acd-49ddce881fbc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "96009675-62be-420b-8f6e-f07fbdd6d06d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3fdc9be5-ec8e-4582-ad86-afdd57feb7fd",
"account_manager_user_code": "sample string 56",
"company_status_id": "ee6bb3d0-9d85-45a4-8e59-f4e42430e353",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-08T05:06:39.2411139+00:00",
"id2": 60
},
"db_language_id": "b66234e4-cafb-48d5-a867-a0002c6574ad",
"db_language_code": "sample string 7",
"db_title_id": "6f41054e-43a0-4983-9dcc-900c3937e399",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-08T05:06:39.2411139+00:00",
"create_date": "2025-07-08T05:06:39.2411139+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-07-08T05:06:39.2411139+00:00"
}