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": "bf76be40-3cd7-440c-8f69-1dcde972bdee",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0baa3843-a141-49cf-abce-059607e6e181",
"company_code": "sample string 5",
"company": {
"id": "5a785149-dd99-4fb6-948e-83a38dab86b0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-25T00:59:54.5676366+00:00",
"sales_territory_id": "721647e7-9dc5-4a2c-a699-82034ab7afac",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f01a8c2d-86fd-4b1e-83d2-cb13f999fdc7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "498e408b-4cc2-4f68-af3c-ba5f7c339204",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f160e014-5f7a-4f14-b4b6-997abebe32cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e95ab6c-ac02-4224-ac9c-f785885d9a1e",
"db_currency_id": "247332b2-1c00-45d0-8891-9d776c7e8d1a",
"db_language_id": "e19082f0-66e7-4e05-9b86-03cf0690c7db",
"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-12-25T00:59:54.5676366+00:00"
},
"modified_dateutc": "2025-12-25T00:59:54.5676366+00:00"
},
"marketing_segment_id": "26d168e3-cdcd-4347-a693-b6f0b04b5eb8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b1a73731-c62d-4092-bedc-41b2718225f1",
"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": "339b59e1-6302-4add-814c-6f794b7667e2",
"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": "c57cd8b0-d89e-43bc-9eba-878b1b12e9b4",
"db_country_code": "sample string 28",
"feelist_id": "869c1ac9-3b94-4a28-bee6-9438fb04d9e2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b5a7e99c-bcc1-482f-b040-66683a6f4dfd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6951f356-093a-4615-987a-657a720a2c52",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-25T00:59:54.5676366+00:00",
"db_currency_id": "d088f91d-733a-4ec6-9a1a-84b8eb8a397d",
"db_currency_code": "sample string 10"
},
"company_type_id": "e76cdec4-0a0b-4e43-9e0c-ac0cdcec1ce8",
"company_type_name": "sample string 32",
"company_type": {
"id": "e57fd8e7-ca05-4f0a-b78f-fb0a8906c2f5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11e94965-f0f3-4f7d-b259-035e52bb6a73",
"sales_organization_code": "sample string 5"
},
"db_language_id": "253e618a-9136-4ff5-a390-d365665aeb51",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "92f4e00a-7d5a-4092-bb3f-e9a1c9ab0781",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "42e190b3-23e7-434d-85ee-24a2a891a039",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ee08aa79-78e9-4086-9bdd-2bbb8e0cbded",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-25T00:59:54.5676366+00:00"
},
"company_sector_id": "8c8d9862-bd21-418b-91cf-65575640b095",
"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": "1c834e0e-74ae-424c-bddf-51e72e11f7cb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fcd50e58-6f5b-474b-a288-12026439605e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "60776085-456f-436c-bfa0-29c0b2f8b738",
"account_manager_user_code": "sample string 56",
"company_status_id": "bb55b066-e033-4225-93d1-a7a768d633db",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-25T00:59:54.5676366+00:00",
"id2": 60
},
"db_language_id": "355ecedb-ff73-4df8-ad19-0d8c2e777e2a",
"db_language_code": "sample string 7",
"db_title_id": "57219dc7-6fcc-45b7-b9fd-eb4e77197fa2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-25T00:59:54.5676366+00:00",
"create_date": "2025-12-25T00:59:54.5676366+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-12-25T00:59:54.5676366+00:00"
}