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": "f4ebbf33-6444-4acc-90eb-c2d5e134e00d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "99e2e10f-1909-4459-8c0e-a6ffcf494f6a",
"company_code": "sample string 5",
"company": {
"id": "56f5cd43-5db7-444f-bda1-05ef819008ea",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-06T19:58:32.1954122+00:00",
"sales_territory_id": "91c4cd11-cbac-4327-b077-41716ec18a06",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "29546f61-c0b6-4ea9-8431-63551427411a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ecd236d3-78b4-4df4-94c4-03f11f3a2238",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4aa8044-3115-434d-8fd4-05a2fdecca71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2a70a3db-2cad-475d-8ff5-202f2941fbcf",
"db_currency_id": "1892046f-6e94-4efa-84d3-485b0c6947cf",
"db_language_id": "c3cf2d7c-6657-4e49-9abb-86bc8f18c0d9",
"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-08-06T19:58:32.2110381+00:00"
},
"modified_dateutc": "2026-08-06T19:58:32.2110381+00:00"
},
"marketing_segment_id": "4249b6b1-ff97-4139-af82-07941033eed7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5aa44c28-abc7-4416-9a18-7633bef9533c",
"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": "2ba96b16-e11d-4d36-9419-2d24f1f779a5",
"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": "c4a6a11c-f0f4-4782-b19c-db802b8a6f4a",
"db_country_code": "sample string 28",
"feelist_id": "f5d20640-066c-4cda-816e-c6572054b3b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e36e9548-52aa-4bf2-82c2-85b884680cf1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bb5c38a4-1edf-4fbf-8890-dff7dd79212e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-06T19:58:32.2110381+00:00",
"db_currency_id": "5f2c3aa4-b955-4aff-b8ca-0c0fe4c7a2de",
"db_currency_code": "sample string 10"
},
"company_type_id": "ee6246ad-5ccc-44e3-81c8-faffa097e27b",
"company_type_name": "sample string 32",
"company_type": {
"id": "8c05cf2d-bc09-4425-9a9c-f502e217f546",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "40904691-9d39-4392-b452-7fc2714262f8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9546b2a1-d0da-4e53-a1f7-251868257cc7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8aaaac57-4f41-4045-b60d-0c0b329d0350",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fbe9d77a-fbc0-42a6-b8ec-38daeaef417c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "92f789a6-566d-4401-971d-7aead59e7890",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-06T19:58:32.2110381+00:00"
},
"company_sector_id": "8a495105-5122-4439-b13c-26d92c09d6da",
"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": "acd53de0-40d3-4acd-ad21-5528d5ead770",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "434bc379-3575-46a4-aba8-d6114f048067",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e173fb29-4af3-43f8-a65a-4fab73fee68f",
"account_manager_user_code": "sample string 56",
"company_status_id": "27e8bec8-a807-4632-86d7-3b012767dfef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-06T19:58:32.2110381+00:00",
"id2": 60
},
"db_language_id": "21791346-038a-4b2b-aa7a-c63768d4495d",
"db_language_code": "sample string 7",
"db_title_id": "4058165b-fd4a-4035-89cd-6b76337e38db",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-06T19:58:32.2110381+00:00",
"create_date": "2026-08-06T19:58:32.2110381+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-08-06T19:58:32.2110381+00:00"
}