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": "e0e96c85-4590-40e9-9a20-5fb67f3746df",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc325b33-6e0a-4c25-bded-8321069e943b",
"company_code": "sample string 5",
"company": {
"id": "ef40fed4-fcb2-4fc6-8c4e-612cebe57e8f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-17T02:52:00.4921105+00:00",
"sales_territory_id": "298c9739-ce94-4fe6-9de4-4a592527fb14",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5e69eaac-ccda-4112-9558-e2482ab9f4e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e4ec140a-26eb-4434-a59f-9ed420da21ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bcbefa81-a2b4-4150-b620-3f942d40d429",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9acebb8d-79b0-403f-bd9e-8450c45e5a61",
"db_currency_id": "fa0d9be9-a814-413d-a0a4-9e25702f485e",
"db_language_id": "912e9090-cb61-400a-9e13-fd2758bdde28",
"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-04-17T02:52:00.4921105+00:00"
},
"modified_dateutc": "2026-04-17T02:52:00.4921105+00:00"
},
"marketing_segment_id": "08c59194-1e54-474c-bcee-6bfd539fce23",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dbc8bde3-1480-4972-a8bf-1b357aad7b63",
"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": "b14577f9-2c73-408d-ac76-5ebc10406a80",
"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": "8ff74ec9-d6d5-4d4e-b822-74b50bfbd65f",
"db_country_code": "sample string 28",
"feelist_id": "e591f9e9-9662-4e04-941e-a3a436c957db",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7ce53440-0cac-46ea-97bd-26b1ee5b43d7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7f7453ec-badd-49c2-b301-d8ef085b4382",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-17T02:52:00.4921105+00:00",
"db_currency_id": "e55a769f-0b4d-481d-a2e1-eef704cb0f34",
"db_currency_code": "sample string 10"
},
"company_type_id": "771ab59c-63c2-4984-bebb-7e29ddfc3347",
"company_type_name": "sample string 32",
"company_type": {
"id": "3c2754ed-40c3-44f9-93ed-cdb232ae0eeb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67284f15-f4eb-4ac7-b902-37d73b49ae9b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1a04937d-80d8-46d2-ad03-33577eab1261",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "316a5fd9-b972-4260-aa7b-00fbd9df0adf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "92ad0045-ce81-4505-b7b6-a04202b0c1ec",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e1ae3447-1366-4d5b-92f7-87a80616588a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-17T02:52:00.4921105+00:00"
},
"company_sector_id": "4c05abec-0240-4382-a5b9-7164e456b246",
"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": "4faf8525-1f7e-44e0-8952-503a5c2358ca",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "89926416-3e2b-42da-9bc2-2f1a66a8c2a3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f18b7845-b1be-484a-a4a7-4172481a831d",
"account_manager_user_code": "sample string 56",
"company_status_id": "6c1f4d5a-282d-439f-8e87-555146d99a61",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-17T02:52:00.4921105+00:00",
"id2": 60
},
"db_language_id": "fcd89087-8275-4818-bbb9-84f2e3d4e365",
"db_language_code": "sample string 7",
"db_title_id": "f9f8ce50-60d1-442c-9a99-c6e7137805ca",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-17T02:52:00.4921105+00:00",
"create_date": "2026-04-17T02:52:00.4921105+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-04-17T02:52:00.4921105+00:00"
}