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": "a5f4009d-57c2-4115-9e9e-e5450ab90eb9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "935805db-6484-4086-98da-f839c74e7003",
"company_code": "sample string 5",
"company": {
"id": "d617da7b-2e76-43be-bd5e-6ff974658618",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-05T12:25:05.3792179+00:00",
"sales_territory_id": "e5eca8bf-5597-4a4d-be24-c8ceb23411e2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cc720397-9d2c-47d4-89d4-a13233eac8ce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7fd60f33-d0b0-468a-83af-41c2ead5448b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "98d8bf91-7f72-4b3e-910a-6a2c24903e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5481166d-1ad0-4b92-aa88-643f9e5f0151",
"db_currency_id": "fbc10d69-550e-4aea-8d12-c23011176c8e",
"db_language_id": "e8c6905a-10d5-4456-899d-315ae062c9db",
"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-09-05T12:25:05.3792179+00:00"
},
"modified_dateutc": "2025-09-05T12:25:05.3792179+00:00"
},
"marketing_segment_id": "19acc0c7-4745-4281-998d-2436709fcfe5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "78dc2217-121c-4bb4-a2f7-83fe094d64ca",
"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": "2c577c69-64e4-4a37-8f3a-b0cf30ccff55",
"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": "e040310a-296e-4d97-bcd3-992f2d6d5694",
"db_country_code": "sample string 28",
"feelist_id": "421820fe-43bc-4fb9-a57a-a10273d0630f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "690a2af9-beba-46bd-8a7b-82dbda5988b5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "261e242e-8971-425b-82f1-8dd61fd4044c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-05T12:25:05.3792179+00:00",
"db_currency_id": "ca858370-ecc0-40ad-96da-472fc84af04f",
"db_currency_code": "sample string 10"
},
"company_type_id": "82271cbb-41fd-4872-837a-55ee6531b7ae",
"company_type_name": "sample string 32",
"company_type": {
"id": "4495ec72-bbe3-40a4-a552-1503a32b17f5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1f5ddb12-37de-48ce-bc7d-57f71b22e00e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1c7595b4-1107-468c-b0ee-12c569ddf2b2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e6f21d3-4e4e-4b20-ab86-afabdaae3f4b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cb2acbb8-630d-45be-b232-4b7ed18927c8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "370bb42d-439f-4c8e-a0cd-e88d4d1bd5d1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-05T12:25:05.3792179+00:00"
},
"company_sector_id": "dbbfbd4b-a72f-40d6-8e68-ea6b9a9cc14f",
"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": "721034c6-c9e3-4817-a8dd-b3b85d1e3f03",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "21e1ebf8-469e-45e8-abde-fa3a2827d78c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "08ea6a20-ae67-41f2-8083-c218aaf9c99c",
"account_manager_user_code": "sample string 56",
"company_status_id": "6445033c-b9a7-4da5-a1fc-52240f405711",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-05T12:25:05.3792179+00:00",
"id2": 60
},
"db_language_id": "811c9a39-32bb-4398-b8fa-8993bad67eb2",
"db_language_code": "sample string 7",
"db_title_id": "7684da16-3058-4f81-9b8f-e3291769fd99",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-05T12:25:05.3792179+00:00",
"create_date": "2025-09-05T12:25:05.3792179+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-09-05T12:25:05.3792179+00:00"
}