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": "067a7d80-62fd-43c0-ad47-b9f4dbf08bd0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0e4d1756-296c-4c2d-b2e7-3c0d8aea35d1",
"company_code": "sample string 5",
"company": {
"id": "eea770a6-7d8b-47a4-9c59-636751b25761",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-23T02:07:11.5167358+00:00",
"sales_territory_id": "1212e281-8c39-423b-9ba0-c76455497d64",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c4bc211e-caee-473b-a7d1-dd0bdb8b765c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6b2b25d-f882-460a-a583-4cb55abbee1e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "09859226-7533-444d-b76f-57b9293744fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21b31165-f812-4216-a465-055a86672896",
"db_currency_id": "583877f2-9676-4317-bca6-e49e8ec98786",
"db_language_id": "29b84cef-5586-4f67-998b-21a03d71e614",
"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-05-23T02:07:11.5167358+00:00"
},
"modified_dateutc": "2026-05-23T02:07:11.5167358+00:00"
},
"marketing_segment_id": "6b73c2c5-8bde-482c-8b55-ab4e3f25ca89",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7b2327f1-bfbf-4d57-bfdb-433dd9fed455",
"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": "d523be5d-5551-47cc-97ec-f713beb6e07c",
"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": "824a7ed2-9e4a-48d6-86b4-e8c939bc7763",
"db_country_code": "sample string 28",
"feelist_id": "861e221b-eec3-4332-9ad8-eb9b2b265ee9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "90171114-c56d-495f-8ca3-3a3c5d2d6a20",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "485c0992-5055-4781-a1b8-a7f755a32772",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-23T02:07:11.5167358+00:00",
"db_currency_id": "0493f415-a13d-4ca0-9742-f53ead46ed6a",
"db_currency_code": "sample string 10"
},
"company_type_id": "53ecc442-dd29-4aee-b193-78ffee9cba6a",
"company_type_name": "sample string 32",
"company_type": {
"id": "5c3626f3-7958-40fa-a44b-d2fcbdeb4b4b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ab1f3240-e0eb-4027-ba36-e02898674c0c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fbddf03f-9607-4f39-a014-f37a96eb33f8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6598eb8a-79d1-404c-b4e3-ece6823099a7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a7e8616e-9d1e-466e-bd22-88404015eaca",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7db18b01-495a-4765-8453-4d6a929c3dba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-23T02:07:11.5167358+00:00"
},
"company_sector_id": "2c2da5e7-a960-4898-a31e-de2e7f7dbc00",
"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": "b39f4f96-26dd-4c26-85dc-84acb6a35c61",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2c73a853-af5c-4ab8-ab13-a6a248108bdc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "779cbb6f-de3f-4121-bce0-5cdaf9ac8bc4",
"account_manager_user_code": "sample string 56",
"company_status_id": "d31a8756-ebef-4d6d-ad41-8b4ca1d02fba",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-23T02:07:11.5167358+00:00",
"id2": 60
},
"db_language_id": "ddd35c85-4181-419d-8183-417c1f242339",
"db_language_code": "sample string 7",
"db_title_id": "d933366f-2395-4e29-afb2-a5c97c720311",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-23T02:07:11.5167358+00:00",
"create_date": "2026-05-23T02:07:11.5167358+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-05-23T02:07:11.5167358+00:00"
}