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": "4357ea51-f903-498e-8f43-5f213cb1ab47",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e62179e0-59de-4d6c-9690-9539992ee199",
"company_code": "sample string 5",
"company": {
"id": "6fb1985b-bd62-4948-b2eb-69f3ece6888f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-04T18:01:05.6467195+00:00",
"sales_territory_id": "d96b94a6-7ab2-4d47-9e15-7f24568a354c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ddd4fe3e-c9b0-49c8-bd3d-162f7d81889c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "97c279fe-e085-4baa-9d8b-4d0696a7487d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6caab44f-f912-4442-9f22-e9351015397e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72f85993-7d76-4c47-a822-05ed2dc66cdf",
"db_currency_id": "3beb7a9d-9495-47eb-9d0d-e94b6b8de891",
"db_language_id": "c6caa2ea-cb19-40d1-82d2-29a999c34fa0",
"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-09-04T18:01:05.6467195+00:00"
},
"modified_dateutc": "2026-09-04T18:01:05.6467195+00:00"
},
"marketing_segment_id": "09f835c3-4bfd-48cf-a421-fe881035a1b7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "214c2e12-c4b4-41a4-9394-98edaffb6647",
"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": "74e90c63-b5d4-44ae-9908-d257744be065",
"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": "cd0ed248-0785-4c28-b974-884e1a36c67f",
"db_country_code": "sample string 28",
"feelist_id": "5d08a834-3ba6-48ed-94bc-099ce6f6f777",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "20f75ebc-c984-4b3e-950e-3ecf1de3c65f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8a621254-e25a-488c-829c-5605d8f155ff",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-04T18:01:05.6467195+00:00",
"db_currency_id": "db21c3d5-30a0-4577-8ae4-ec4a9028d0b9",
"db_currency_code": "sample string 10"
},
"company_type_id": "ac7e07fc-3431-41ff-bd39-87820688880c",
"company_type_name": "sample string 32",
"company_type": {
"id": "7e4c527d-f07c-49fc-b705-cdf4730e5dff",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "61a9c51f-fcbe-40ab-afde-4bd6e3c74a91",
"sales_organization_code": "sample string 5"
},
"db_language_id": "039b59db-ef25-49a7-b5e9-29feedba35ed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dbcf5ef0-51e9-42a2-a9ff-dcb3c978e197",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e40d5943-7011-4472-b5c5-1ddf98adda12",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3e293e90-ba82-4a9d-9ebf-20d5b8440f49",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-04T18:01:05.6467195+00:00"
},
"company_sector_id": "d40dfd54-e081-44f7-b32e-f0cfca907eed",
"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": "2199ada6-85b9-4d08-92d1-3c5a2cb5aa21",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c7491e0f-328e-43de-8c8c-b74b1bc83486",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4d860c89-8212-42ac-8a67-b569e8ce2098",
"account_manager_user_code": "sample string 56",
"company_status_id": "90fbfdc9-7d78-44c4-a398-354033816bd8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-04T18:01:05.6467195+00:00",
"id2": 60
},
"db_language_id": "29859263-0c52-42d4-961f-6c384374a2c5",
"db_language_code": "sample string 7",
"db_title_id": "85a83ca0-584c-4268-ace6-dbebbfd38a94",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-04T18:01:05.6467195+00:00",
"create_date": "2026-09-04T18:01:05.6467195+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-09-04T18:01:05.6467195+00:00"
}