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": "734d9880-1948-4316-8285-c05620f9075c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "98176d99-0364-4928-aede-ea9d6c59a915",
"company_code": "sample string 5",
"company": {
"id": "5be544ac-d6f3-48b2-819a-e4199e9832d4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-21T00:07:25.6201159+00:00",
"sales_territory_id": "7277ef5a-6f6b-4d88-93f4-133c84c4f4bf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "85566503-bdf6-4d8c-b5b6-4cff0cb66c7c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a8b9ed9-72a7-47a6-b41a-dcc63a3073e7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ce13c13b-2551-4316-9cbe-7c94a3cd372e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30c37032-fb73-4e18-9056-0880c18032fe",
"db_currency_id": "38d4c2a8-0913-4ad8-bacd-cc3c240989f4",
"db_language_id": "0cabab58-a712-4d29-9158-612fc4481e78",
"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-02-21T00:07:25.6201159+00:00"
},
"modified_dateutc": "2026-02-21T00:07:25.6201159+00:00"
},
"marketing_segment_id": "a815c5f0-c90c-417f-8c66-3a864839dd71",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ab441e0b-3852-45d1-8433-5e4e29bd2a69",
"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": "f22b949a-0e77-4ed1-94aa-babf530cf47f",
"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": "76a5ec0e-b68f-42d7-8b9e-26860e3d1d98",
"db_country_code": "sample string 28",
"feelist_id": "f78b7c75-8334-4611-9be4-bf101aebc325",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "289df58d-a4a4-428e-a240-50e43ee4b2f9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6017f5ad-3183-48dd-9bca-c52497929120",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-21T00:07:25.6201159+00:00",
"db_currency_id": "c595fe62-d77b-45a2-bbf6-65a179536960",
"db_currency_code": "sample string 10"
},
"company_type_id": "7866cff7-8db6-465f-822f-cf8cd64eb31f",
"company_type_name": "sample string 32",
"company_type": {
"id": "f0145d26-9a2d-4b5b-b93f-8130a101eb99",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e3313b54-ae90-4532-94d0-ab96cc54c8a9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "df0cd034-5492-4882-9580-1a2332443fc4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "36b4ec6c-c03b-4c43-8d71-bd3e54a84163",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d76a7d15-2bb2-4423-83df-3f5492fb3286",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "15d2c2ab-fc45-4e5f-981f-f4ce2b95b68f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-21T00:07:25.6201159+00:00"
},
"company_sector_id": "dbe8b962-ead3-48b7-9dad-fa9d69eb480e",
"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": "00b4b041-d040-43f4-9ef0-c09ca91d7ce2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f9081f75-a81f-498a-b3e2-d82fcffc021e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e39cc834-be13-4d48-8a5d-00ea00d1f143",
"account_manager_user_code": "sample string 56",
"company_status_id": "8f2a4b47-eab2-46f4-b9e0-61422407597b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-21T00:07:25.6201159+00:00",
"id2": 60
},
"db_language_id": "9587b599-98ec-4c07-b513-3ed6cb95990d",
"db_language_code": "sample string 7",
"db_title_id": "b2615e25-eda0-402e-8ceb-a4110a73f674",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-21T00:07:25.6201159+00:00",
"create_date": "2026-02-21T00:07:25.6201159+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-02-21T00:07:25.6201159+00:00"
}