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": "6cca4253-af7c-4cf4-b6e4-b3a3165d350f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6d3e6414-0815-4af9-8406-b6e7f17767f6",
"company_code": "sample string 5",
"company": {
"id": "a7cf1789-f56c-4beb-bb04-57c9aa0a5561",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-02T13:09:59.1796766+00:00",
"sales_territory_id": "2d9445dc-0203-4c65-9f80-a9ff293e77ee",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c3dfe749-47e5-4ccd-b629-f3faa6bd78f3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1624f5bb-ed2b-48de-bf73-8bc2f79f2368",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d6e10a4a-2eb4-49d5-87dc-35f494f903f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29a80001-4c94-4c64-83ef-785caf620591",
"db_currency_id": "b8a55f31-5ccf-4927-a4bd-17425731fcd4",
"db_language_id": "70328c98-af46-4bd7-af59-0529c2ffdb72",
"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-02T13:09:59.1796766+00:00"
},
"modified_dateutc": "2026-02-02T13:09:59.1796766+00:00"
},
"marketing_segment_id": "83eb742d-d3ba-41f6-ae3c-31da9369947a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cb5844a6-c975-4bb2-974c-20fd4527a3bc",
"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": "5850af62-bf0f-4cf6-9b63-74f832320096",
"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": "83728e14-39f4-46da-8470-3b7302101235",
"db_country_code": "sample string 28",
"feelist_id": "a296166c-055f-4c12-9d5b-25744bba21ea",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f9319d1a-e9fe-485e-9722-e563a32ce94e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d829ffee-9117-4925-8b1e-9b5fb6463a9c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-02T13:09:59.1796766+00:00",
"db_currency_id": "6e88ff2a-fe85-425a-bd5f-6743172c2d34",
"db_currency_code": "sample string 10"
},
"company_type_id": "c13625b4-4114-4751-b313-04f4273e9f01",
"company_type_name": "sample string 32",
"company_type": {
"id": "b51586da-5ad9-4709-aa7f-117064c81b86",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a4fdd0cc-bee0-4402-99e9-db1e7b567696",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7a0dcef1-bc2f-4018-b9a3-f9174413ae50",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e4f0561a-8068-4f3f-a869-7e0009b03e4f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b9bc8f31-6009-4b6d-8c04-efd92480bead",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d39be5da-1637-4a63-a397-67eff05cca58",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-02T13:09:59.1796766+00:00"
},
"company_sector_id": "2425f4e4-74f6-4e7d-81d4-54e09bd2a9bc",
"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": "ac958bcd-de1c-40e1-8972-dd4a0f773d4d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1bfe25b7-2f4c-41c6-a996-a33530872aef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c560cdfc-949e-4b84-bd34-934b00d0d041",
"account_manager_user_code": "sample string 56",
"company_status_id": "e8c2b904-7546-4292-a1fb-11fb4c340dc6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-02T13:09:59.1796766+00:00",
"id2": 60
},
"db_language_id": "fb704df9-4df6-4a64-ad28-84509ca44181",
"db_language_code": "sample string 7",
"db_title_id": "f7e668d7-2bf8-4d00-9a0a-5184b163b251",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-02T13:09:59.1796766+00:00",
"create_date": "2026-02-02T13:09:59.1796766+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-02T13:09:59.1796766+00:00"
}