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": "0a253952-f07b-495e-a02f-f70110697f31",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1603e6e0-1411-4b7f-947c-7c8820ed5bb7",
"company_code": "sample string 5",
"company": {
"id": "defacf29-3206-46f8-9338-bd64bc4f6ee6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-09T04:46:26.7706512+00:00",
"sales_territory_id": "661bcffc-616c-4a52-8d0f-e059d948d71a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "67d4098c-a284-4d17-8420-2c0c73a5559e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f1640f1-d303-492e-bba0-8b734debd5bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "588d7f1e-fabe-4fab-a38c-712b4ce1e454",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28b7ebeb-a6b5-4958-a71f-c6e253eccbcd",
"db_currency_id": "e175d992-e234-4556-bd31-5d5550b68b6e",
"db_language_id": "b1061b75-ea55-456e-9bee-ee8e1b9f6210",
"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-03-09T04:46:26.7706512+00:00"
},
"modified_dateutc": "2026-03-09T04:46:26.7706512+00:00"
},
"marketing_segment_id": "34b101a4-0973-4e34-a4b8-6de66d1b134f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "87ebb5d4-3ca4-45e0-9954-1660ebabeb95",
"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": "d21d1a37-aabf-4a78-a329-2fda0be22a69",
"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": "221f0cc2-264f-4c5b-99ce-9411449f4675",
"db_country_code": "sample string 28",
"feelist_id": "034aa234-ae40-42f6-bebd-82d29df5796e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f351db66-1fb8-4a73-9bc8-a47c7c80de66",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d84931d3-77da-49e4-a6c4-90d615334161",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-09T04:46:26.7706512+00:00",
"db_currency_id": "fbc500ab-a48e-40b8-968a-e84ca4eb43b9",
"db_currency_code": "sample string 10"
},
"company_type_id": "df93adac-adfe-484c-9604-743cdbafd832",
"company_type_name": "sample string 32",
"company_type": {
"id": "70e348a1-94d4-4c3e-9dd5-e244219ccf13",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0822f424-2ed7-4252-8e04-21643e3070bc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "498001a9-0c4e-43d7-a2af-a16bd7e87e11",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "345a9293-0251-4d99-978c-56058a283f73",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "62aaeb41-c213-4f02-9251-46a788848d91",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8f741f2e-03ad-4a9d-bfbe-853c55bcebb9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-09T04:46:26.7706512+00:00"
},
"company_sector_id": "dc2dee60-c1af-4a3e-a156-99b44cf7c45b",
"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": "271a9ae0-af4f-4ba8-9f17-3c329a48194b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cb8a230a-3240-43ec-a4ca-5c4d0b382d20",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b88339a2-f882-4842-ae4d-18303408a996",
"account_manager_user_code": "sample string 56",
"company_status_id": "02e9012f-8c67-462a-a24b-dc3ba9ff4d4c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-09T04:46:26.7706512+00:00",
"id2": 60
},
"db_language_id": "1f87e423-5c98-4678-af54-a07907919058",
"db_language_code": "sample string 7",
"db_title_id": "b7a5f541-7d23-4e00-b7c4-a99294249e98",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-09T04:46:26.7706512+00:00",
"create_date": "2026-03-09T04:46:26.7706512+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-03-09T04:46:26.7706512+00:00"
}