Retrieves the 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": "3959e20d-041b-4867-8a98-57cdce823529",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "518ab333-c5d4-4013-bf47-c23fb1946563",
"company_code": "sample string 5",
"company": {
"id": "689587b1-eb4b-4133-a619-7d6738ecd359",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-20T07:43:33.1655868+00:00",
"sales_territory_id": "95cb8ac9-4dc9-4a01-8ccd-ec08ac69c23a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "49a52dc1-dff9-4fd1-81a2-434cf16a67d8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a36527bf-e771-40a1-961c-012f29bf32e4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9cae329f-09a2-49c0-aa56-a41c8f5f4c14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "05c4f183-2355-43ee-adcf-acc0b2c9b460",
"db_currency_id": "2977ddf8-44c4-4196-9c26-35f98cd21259",
"db_language_id": "e0e81339-c03e-4352-adb4-9e8c4c3e42d3",
"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-04-20T07:43:33.1655868+00:00"
},
"modified_dateutc": "2026-04-20T07:43:33.1655868+00:00"
},
"marketing_segment_id": "efe0c1d8-641a-4f15-b6ac-6414dc65b647",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "62e8fb6f-9d23-44e9-9842-b05a4023c5e4",
"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": "8afb10a9-607f-4839-bbbb-09e4859dc0a3",
"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": "50a04008-53f1-417d-8a28-1fe69bc0e8b0",
"db_country_code": "sample string 28",
"feelist_id": "5b35477f-a3d9-45e8-800f-a911531ef6ba",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dd6fbd9f-7a1c-4010-953a-0f0b44651473",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cd51514b-f468-4549-80b2-cad0199dd6d0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-20T07:43:33.1655868+00:00",
"db_currency_id": "1c66b44b-e42d-4069-98ce-71f6bc683fac",
"db_currency_code": "sample string 10"
},
"company_type_id": "bb91788c-22e7-4a74-988e-2d3d023e6b68",
"company_type_name": "sample string 32",
"company_type": {
"id": "ff7e5620-db45-4765-a5c3-494f226df5a5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a14477b9-da76-456d-8222-73a19729271d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4d6c8622-8321-4bc4-bb80-2bfe459495cb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b0f0827d-5641-41f9-80a2-d47e7a0d4b27",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3d8579a9-ea95-47ca-9e53-8802bbef1f06",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "97800965-2167-4752-947a-1ad3e22ab9b1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-20T07:43:33.1655868+00:00"
},
"company_sector_id": "b4a16280-d087-41c6-8509-54d2297d8c3d",
"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": "608f2ca9-853c-4228-8d2a-c42cd731e87b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8bf7880c-fa82-4488-96b2-ebbd246cd6ed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "241ec85b-8cb5-4c37-8813-ca6679abd2e7",
"account_manager_user_code": "sample string 56",
"company_status_id": "71573aba-5a28-45dc-945e-fcb790e9052f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-20T07:43:33.1655868+00:00",
"id2": 60
},
"db_language_id": "fc83f72d-bcf9-4ce7-b9e1-796a3ae77064",
"db_language_code": "sample string 7",
"db_title_id": "412339d8-829f-4f07-9284-c4f92d2dcc0b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-20T07:43:33.1655868+00:00",
"create_date": "2026-04-20T07:43:33.1655868+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-04-20T07:43:33.1655868+00:00"
}