Retrieves the company contact with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "f5014dec-d506-4ece-a903-922b9fd1b6f3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f90da118-7369-4e69-a581-1785056eef3a",
"company_code": "sample string 5",
"company": {
"id": "2c7bfaa5-8734-404b-bd04-100fbb38e930",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-06T01:03:36.2018389+00:00",
"sales_territory_id": "39b20c52-dbd8-4f48-97e8-c9f7503b1e2e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "42566b39-7288-484f-a8d5-610374834b03",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ec291a70-1f08-4aa5-b6bd-e4869e380350",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b783cf8b-4f1d-43dd-81b9-65f6ee4fdb1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b9cdb5e-1218-479c-aacd-88de4ac1ccc7",
"db_currency_id": "62504f29-f8cb-4dd4-8581-136dd13bbd32",
"db_language_id": "9e738d08-a995-4f46-a238-7eeb6dd47885",
"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-10-06T01:03:36.2018389+00:00"
},
"modified_dateutc": "2026-10-06T01:03:36.2018389+00:00"
},
"marketing_segment_id": "7b88ea2b-1f56-4c49-9f99-b6b97f933204",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4c9d7865-9b4d-4f8a-8c28-b37f33107f35",
"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": "e21dc2cf-a53e-4565-a5b1-9d81dba8c4e1",
"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": "94e8afa2-5f70-4d66-832f-f97ed1875f74",
"db_country_code": "sample string 28",
"feelist_id": "e4b336e4-f606-40fa-83dc-71b23a2eda99",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d753653f-40e5-4ab0-8472-b8fa8871d2fc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "46856f13-8121-4623-b3ab-c0511d1715ec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-06T01:03:36.2018389+00:00",
"db_currency_id": "e6e36482-0230-4de9-9a2d-d048ddd0c562",
"db_currency_code": "sample string 10"
},
"company_type_id": "7168d053-17e4-471a-a2d3-99956e0cd6a1",
"company_type_name": "sample string 32",
"company_type": {
"id": "ffa25d25-8517-4f27-88b1-b8e3771e6972",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0053bb3e-6982-4761-9687-5ef2d851c85b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ffd0e8fc-a361-498c-8664-f38f66b2fc42",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "43085732-a3e6-4231-9da1-9dbda3b53042",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "743c597a-e170-4b32-88d6-824e293d0136",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4f23c0cf-83c5-4a1b-b59e-163e4a1f9511",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-06T01:03:36.2018389+00:00"
},
"company_sector_id": "7cac97f0-0d2e-4953-8de4-d030fa69aae3",
"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": "ef1f5884-65b6-4bba-aace-590ac499a074",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0ee4d6f7-b266-4a77-bed3-f17e3d2e1aac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9cb16881-38e5-4792-9df5-35bbc97cdedc",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3f0ecde-2efe-4202-a889-43f84dfecc58",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-06T01:03:36.2018389+00:00",
"id2": 60
},
"db_language_id": "04ab7118-26a5-44c2-8933-248de417e4ab",
"db_language_code": "sample string 7",
"db_title_id": "5e517ea8-de1e-4b8b-aa25-f8ef35860552",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-06T01:03:36.2018389+00:00",
"create_date": "2026-10-06T01:03:36.2018389+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-10-06T01:03:36.2018389+00:00"
}