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": "c7604c66-f30f-4199-83b1-44ebe1fd7bad",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "221da769-9ad9-4a50-baee-0435eade0137",
"company_code": "sample string 5",
"company": {
"id": "81fa319b-8bc7-4fb2-90d5-e638a71be849",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-18T01:52:22.8999444+00:00",
"sales_territory_id": "947005bd-9a4f-403e-8879-fdaa9dc3cf39",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cfe9b6b0-7f96-4790-aff0-611cd6572fd9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b85a061-f9ea-4054-93bf-a6b7108d5ea2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9e72e00a-7d5f-4f44-bdc2-23bee3239f01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca0ed9b5-3ec5-4acf-ab03-9a6f31300c8d",
"db_currency_id": "1bea52ef-1034-479e-afd5-eae28d96c99b",
"db_language_id": "967ba528-68d0-42fa-a68f-2c065cf11bed",
"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-10-18T01:52:22.8999444+00:00"
},
"modified_dateutc": "2025-10-18T01:52:22.8999444+00:00"
},
"marketing_segment_id": "cb5a5730-1bbc-41b8-8f41-b23af5342caa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "93c79ae7-66e5-4263-8419-76a4f9271c9b",
"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": "11c97bd6-4ef5-4693-915e-840317ceeab2",
"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": "54ebb01b-7984-4cc9-92dc-bdc1f68c88c2",
"db_country_code": "sample string 28",
"feelist_id": "6484b478-84bf-4cdf-a900-423e6e150ff8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a1ea696f-b79f-4cca-8b6b-6b241b512ab6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3ad0c0df-c608-4751-af38-09e31a27becf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-18T01:52:22.8999444+00:00",
"db_currency_id": "4a88b37a-8482-4368-a6f4-9db8091e149f",
"db_currency_code": "sample string 10"
},
"company_type_id": "14329712-d234-4b86-b51c-fd0bbaf9d425",
"company_type_name": "sample string 32",
"company_type": {
"id": "4aff3364-6035-4803-9060-546c33543a9b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3d5787e6-f7ec-4992-8652-d7f5e8203945",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f38e48c1-3781-4879-a222-733eb1047e83",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a56c9408-4afc-4fab-afdb-39e6558acbf4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6fc96e74-b1d9-48c7-8f34-7af9a0e8f05d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0a5c1a33-8820-4809-888b-4f6843943d2b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-18T01:52:22.8999444+00:00"
},
"company_sector_id": "c0999d42-defb-4f90-a179-38be943134db",
"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": "794bd08b-15bc-474e-b6b5-74c152430537",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bef1004d-6426-4213-85be-14d2f782ba9e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "706b7063-3d97-465a-ba72-9db7881eb0c6",
"account_manager_user_code": "sample string 56",
"company_status_id": "e8be6969-94e6-4d2f-8b8a-b359a74f5208",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-18T01:52:22.8999444+00:00",
"id2": 60
},
"db_language_id": "217a15c0-2b1b-4f26-a4b2-7f18bac7c20c",
"db_language_code": "sample string 7",
"db_title_id": "4a609c3d-1d0e-4d9b-bdff-219d71fe34e1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-18T01:52:22.8999444+00:00",
"create_date": "2025-10-18T01:52:22.8999444+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-10-18T01:52:22.8999444+00:00"
}