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": "b09810db-4758-432a-b9e2-494371f6176c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b83662f1-ac46-43fe-8af6-03bfbe49e96b",
"company_code": "sample string 5",
"company": {
"id": "6d8c9757-79fd-4e5d-ab7f-7cdaec182754",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-29T14:29:41.2983114+00:00",
"sales_territory_id": "072904d3-0227-49fa-b4d1-4895d57b3678",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7389c5ab-ba97-4834-b9ed-70885d2958ad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "55cd46c5-3122-4820-9c63-2b15db9e8d4c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a38fb71e-617b-4268-8220-a3fc93882994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e796bd6e-bcb3-4ca5-b790-7ec40b404630",
"db_currency_id": "86cf874a-af0b-44ab-83bb-e3cdd7751872",
"db_language_id": "d57187f0-b010-4413-aa70-1c7d74072e7f",
"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-29T14:29:41.2983114+00:00"
},
"modified_dateutc": "2026-08-29T14:29:41.2983114+00:00"
},
"marketing_segment_id": "cfe92532-7c03-4f82-b7a2-73064d6592c0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d633e3d6-f048-4c0c-b947-5eaa15a12d48",
"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": "c870c94d-8fc4-494e-af94-4edeb6fd2abe",
"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": "1a52d05f-463a-4848-a97f-ba0e55dd51e0",
"db_country_code": "sample string 28",
"feelist_id": "04d6bc57-8c08-46c0-a95c-d6305d58588f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0a2cef35-a93f-4bab-a9b1-5495087a1ca5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "00e068e5-2a7f-4409-b9e7-cf08c5f3748d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-29T14:29:41.2983114+00:00",
"db_currency_id": "9b9b25bf-882f-4b29-84c9-2f489357ea9c",
"db_currency_code": "sample string 10"
},
"company_type_id": "a5c6d5ea-2675-4b66-8349-e619950548ed",
"company_type_name": "sample string 32",
"company_type": {
"id": "c43a1da1-5af1-4ce6-b1a9-c6e3ba0edb83",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae257661-e173-4a7b-a34c-174644cdc603",
"sales_organization_code": "sample string 5"
},
"db_language_id": "34e04fb8-0718-4ae5-a932-0d1050eac284",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c3d75371-9cc8-4004-b335-421424d2ee61",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "13230cfa-3d53-4d75-a0b7-07bb17b7462a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0e2029d7-407a-4992-852a-fb456aed3fb2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-29T14:29:41.2983114+00:00"
},
"company_sector_id": "41a8cfd8-edef-49c3-999a-137723caf10a",
"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": "be79cfbd-5330-4a0c-be77-a128e94e1e5a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "46d3fa11-4a02-4516-9646-abe644a1ba0a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "52f59f67-b1aa-4201-983d-38149f55afeb",
"account_manager_user_code": "sample string 56",
"company_status_id": "e2907207-90f0-43d0-a034-20e524fee4ae",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-29T14:29:41.2983114+00:00",
"id2": 60
},
"db_language_id": "c3193f17-606f-4049-9bad-a74ecb4bd674",
"db_language_code": "sample string 7",
"db_title_id": "c88fbf92-21e1-48b6-a12e-f46600ded7d3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-29T14:29:41.2983114+00:00",
"create_date": "2026-08-29T14:29:41.2983114+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-29T14:29:41.2983114+00:00"
}