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": "e0b10286-500c-46fe-9e96-698a3563cb5d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e663066e-649c-4995-af92-6de806de0df7",
"company_code": "sample string 5",
"company": {
"id": "2028f688-2e5a-43c9-a0f1-6fd95e7a4df1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-23T10:46:20.1073355+00:00",
"sales_territory_id": "d800d1fa-32a0-4d9d-abc6-24edd536d782",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2ced8673-3ace-466d-9993-6157601be590",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b7b4c75b-7f2d-4aca-9b5a-a4b3e455d2b1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec0c12b6-f04d-40ab-b565-3eaa9018a5d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5869291d-9edb-42f4-888a-9887f70af96d",
"db_currency_id": "799f477a-fab2-47ea-bd43-e01aa577b46c",
"db_language_id": "2ff24e32-138f-4fd6-8f62-55ca4cf21794",
"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-23T10:46:20.1073355+00:00"
},
"modified_dateutc": "2025-11-23T10:46:20.1073355+00:00"
},
"marketing_segment_id": "f58af283-b750-4969-929e-d21b328a991e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2e5eb894-71c0-4501-8fa1-f9a3acc42c02",
"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": "bb367d84-cab4-4c11-bca7-927d8a120634",
"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": "30028d6b-32b8-4d78-b2db-d3e11e3a3d57",
"db_country_code": "sample string 28",
"feelist_id": "7cd57236-1eea-4621-aeb4-fbae8bb6f3e3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "af6849a6-50ad-4c87-9472-8ae33c56b2e3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2ed74800-7875-4ae8-be61-a19ac1bf7c0a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-23T10:46:20.1073355+00:00",
"db_currency_id": "47e86902-9082-43bf-91c7-82d171d1669c",
"db_currency_code": "sample string 10"
},
"company_type_id": "31aeba65-0feb-4422-971c-51a4448b8cc9",
"company_type_name": "sample string 32",
"company_type": {
"id": "aef68fec-5f8a-4c96-b8af-34972f4ce659",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "72f2e624-9b4b-40e7-a3e4-6b46f3e84e7a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "553d8fb6-e450-4a06-9174-6b41aa428fb2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c18058e2-1eaa-4bbf-8024-7833414d4994",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7ce9878f-68b1-44bc-801c-3f731137756c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5be623ab-da75-4750-8dff-2a8163dda153",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-23T10:46:20.1073355+00:00"
},
"company_sector_id": "35b1a73c-27ea-4035-b2b2-86111b609e50",
"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": "2ff0c604-71a5-43f3-9eaf-1228b87930bf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cda5bac7-6edf-4fde-be25-b5769eb37baa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9431d4c3-cb9e-4ea6-bada-f79cd4d18c2a",
"account_manager_user_code": "sample string 56",
"company_status_id": "7df3c237-49c0-4dc8-b97d-4dee3039b7aa",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-23T10:46:20.1073355+00:00",
"id2": 60
},
"db_language_id": "c04bbf70-1156-4a40-b1a7-3f6d901361f7",
"db_language_code": "sample string 7",
"db_title_id": "c7109957-a342-4ab1-950f-b927057626d2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-23T10:46:20.1073355+00:00",
"create_date": "2025-11-23T10:46:20.1073355+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-23T10:46:20.1073355+00:00"
}