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": "aa6894d4-cc7d-48b8-af2c-5efe9f81333a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e8a3cc39-d0d4-406b-b8d8-310e226f8c7d",
"company_code": "sample string 5",
"company": {
"id": "8901add3-5666-4bdd-9fb0-f5bc7f8b768e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-16T06:48:37.8988733+00:00",
"sales_territory_id": "7c32b1e3-8e14-4e90-af87-891d0e869e40",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "412b7fd1-bbb0-486a-bee4-a0855395e8f3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f75ecd35-686f-4b22-87a8-9b2b5de33a4e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a563097-0b41-4c04-ac03-0d95691ee000",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf12404-71e4-4eab-ad3d-550d87614016",
"db_currency_id": "22ca1257-75d3-4e25-8446-5cff43d46c86",
"db_language_id": "5f6bb536-3b55-4179-b710-f43669b21e16",
"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-10-16T06:48:37.8988733+00:00"
},
"modified_dateutc": "2026-10-16T06:48:37.8988733+00:00"
},
"marketing_segment_id": "6db789bd-9f59-44ee-aa27-9dbacf0660a0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "deae3c01-5929-40d7-9e0b-c6a72f4a8da9",
"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": "0ce53382-e575-490c-ad55-601de8b71c65",
"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": "67df3295-31ce-4ed5-8ad8-97fe96337395",
"db_country_code": "sample string 28",
"feelist_id": "d0747e20-cbfa-47ec-8d31-8e0575406233",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8f7a069e-b43d-4aac-947c-0df64e8d1e50",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a97ba127-5166-4fc9-a4db-4495b606693e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-16T06:48:37.8988733+00:00",
"db_currency_id": "e04db6c2-bd4d-4e41-b6b4-7869151ed171",
"db_currency_code": "sample string 10"
},
"company_type_id": "a06cfbb1-aba0-44e8-8692-e90fe980dd1c",
"company_type_name": "sample string 32",
"company_type": {
"id": "3eb8f97f-ac6c-4131-a273-aa34a484d4e0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2983d21-d5b4-4efd-a389-79cfcb1bb44e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7ae5c10b-0c04-45c8-a48e-b57d37715f18",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ed355a3a-fef7-4e20-8eb5-de6c9c24e0b0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5deebffc-3235-4d26-be67-a2a5460def3d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a956a143-855d-46db-916b-fc461e404766",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-16T06:48:37.8988733+00:00"
},
"company_sector_id": "a6697051-d827-4840-8d18-79c27de7eab6",
"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": "dd4592ab-ac00-4717-a656-2bc7898d03ca",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ba15b25b-daac-4cee-bab6-de021d433d89",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9c24d911-6df8-4274-8139-dd79f9a4d8e0",
"account_manager_user_code": "sample string 56",
"company_status_id": "0359d194-4bd3-4190-8244-3c33a9f1722e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-16T06:48:37.8988733+00:00",
"id2": 60
},
"db_language_id": "edbaf07f-cbc0-4cb8-bfe3-3578d953e372",
"db_language_code": "sample string 7",
"db_title_id": "e7917515-e78a-4f66-a7e1-90bf985399b8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-16T06:48:37.8988733+00:00",
"create_date": "2026-10-16T06:48:37.8988733+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-10-16T06:48:37.8988733+00:00"
}