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": "1f6d1144-a014-4896-9087-3de16d0ba443",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b43f8936-6fbb-4c26-b5d4-b9e2375f93f6",
"company_code": "sample string 5",
"company": {
"id": "d85b3f27-50a3-40f4-a0af-c7d1c8daf6e1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-06T10:45:46.8139376+00:00",
"sales_territory_id": "23fcf5a5-5627-414c-9b9c-110996adee8d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "41aea612-f8e2-49c5-8950-b23496421789",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c78c6e0d-de18-4824-9bb8-ec4175b6ccc4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b164b33-52b1-4d86-a21d-cd771e2cc5f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8e96e4c-5ccb-43bc-b152-7a680d3e73e0",
"db_currency_id": "cde83780-dff5-496d-a7c8-3d3a87c9933c",
"db_language_id": "84efa288-0155-41f2-ab87-6ed09ba62d87",
"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-07-06T10:45:46.8139376+00:00"
},
"modified_dateutc": "2025-07-06T10:45:46.8139376+00:00"
},
"marketing_segment_id": "a49ea6b8-547c-40fa-a490-1cceadb42ae9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b59e96f8-8f18-49e9-af05-2eac17d583b9",
"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": "b506cb8d-b4b0-4c40-9c40-d2c8cc0be343",
"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": "ca5ae7a9-fe79-4852-971e-d8a4dc738beb",
"db_country_code": "sample string 28",
"feelist_id": "51548f7d-03d5-41da-ad6a-0e243de876f2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3fbe9904-055a-4c03-8dc6-59bd385341b9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b3d73c17-f6dd-4536-9d2d-d811b6737eb3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-06T10:45:46.8139376+00:00",
"db_currency_id": "f82a3872-2f36-400e-a3da-abc2b262950f",
"db_currency_code": "sample string 10"
},
"company_type_id": "94ed21f7-ab1d-472a-b168-84f1419a1313",
"company_type_name": "sample string 32",
"company_type": {
"id": "b3e5b600-e23c-4ff2-8551-c07f78c5a2cc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a34f8043-bba7-45f7-96af-f4c3425299e8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "57c2921e-6397-4867-ab36-4d3fe91c671f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ee898592-397a-4020-a0f8-7ad3e4eb6b2b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0d50e773-280b-4220-ba35-23bd174ed534",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0c40cb25-2f52-4b0c-bbb8-647d95e8b0ae",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-06T10:45:46.8139376+00:00"
},
"company_sector_id": "33a24f6c-1d71-46fa-9701-808cb07801f2",
"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": "773f3258-db68-4da0-aabf-d52e4a0157e6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "88c50383-4a54-4799-93a8-9f76fc2cdcdc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0a5e560a-3976-4178-a11a-5b069841a203",
"account_manager_user_code": "sample string 56",
"company_status_id": "5c147617-e8d3-41cb-ac4f-b2e6d40bba5b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-06T10:45:46.8139376+00:00",
"id2": 60
},
"db_language_id": "46efab61-86ab-4d3b-8aa9-9c4201bcdf13",
"db_language_code": "sample string 7",
"db_title_id": "82b60d9d-4e09-4f5b-9132-37c761823ce6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-06T10:45:46.8139376+00:00",
"create_date": "2025-07-06T10:45:46.8139376+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-07-06T10:45:46.8139376+00:00"
}