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": "718d1bdc-1634-434d-b21d-72ea848e786f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "893131d1-ab47-4c97-b409-82aadac4642b",
"company_code": "sample string 5",
"company": {
"id": "49674291-cdb4-4753-aaf8-2eb5026c567a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-07T12:57:20.7128952+00:00",
"sales_territory_id": "0e16bbfe-6d20-4f28-b418-201641e063b5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a2ad5a45-df20-47fe-ac12-6b79602c22be",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8f5713d5-d812-4f87-9309-fa42c77ed6bd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7542f39-5747-41c3-9edf-551d8f965642",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bfff6d3c-d216-43eb-9e59-d540ad980970",
"db_currency_id": "5a144f30-d228-4850-96cc-2c30f5142349",
"db_language_id": "0d76a9e7-ad0a-4c0f-8c0b-3cc43dd89e90",
"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-01-07T12:57:20.7128952+00:00"
},
"modified_dateutc": "2026-01-07T12:57:20.7128952+00:00"
},
"marketing_segment_id": "36a84cef-515d-4ed7-80f9-e876cffed731",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5e8d79a4-4576-457b-9e78-0c80a2f95100",
"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": "02bc2796-50e5-46fe-ae08-681c01cba5cf",
"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": "f7c1aedb-6f9d-4691-929c-30f9cb67f996",
"db_country_code": "sample string 28",
"feelist_id": "864517b2-9f4b-47e3-b46b-0450b0cfd97e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "28a583a7-40b1-4e70-a91d-547e4cfb693c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "822f7ecd-51a3-4e96-805c-98a80e5b1b68",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-07T12:57:20.7128952+00:00",
"db_currency_id": "2ac6160c-0a00-44aa-a96e-8308caa3ef8f",
"db_currency_code": "sample string 10"
},
"company_type_id": "0ef1fb42-3cb0-43a5-9aeb-5da051e8948d",
"company_type_name": "sample string 32",
"company_type": {
"id": "db3fcf6d-5c41-4acf-87ae-91743ebdd497",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81e015f8-a234-4e79-ad1e-496c41f468c0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0d2ba3d1-3c8a-45d1-8d54-7e53e9ba83a4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ed6f6fef-a017-4246-aa36-a23ab51d4afe",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a52908a8-4fb4-4cdb-9293-40273333c520",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "376e9e68-9f75-4c42-881d-643036dd8839",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-07T12:57:20.7128952+00:00"
},
"company_sector_id": "886f3381-3dd6-4b5f-8934-52bf34c07300",
"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": "5572c778-45e9-4fd4-a4fa-4314133a703f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "85ea39fc-db08-417d-9260-8923b815fab6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "45432394-7e67-4109-b818-2afe79fab647",
"account_manager_user_code": "sample string 56",
"company_status_id": "67f54a4f-fe46-45fe-b1dc-6db37ada0196",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-07T12:57:20.7128952+00:00",
"id2": 60
},
"db_language_id": "f1f315db-7c2e-4fe1-8c45-aed547db81e2",
"db_language_code": "sample string 7",
"db_title_id": "dcede4dc-9795-4bc6-9c14-87073058e801",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-07T12:57:20.7128952+00:00",
"create_date": "2026-01-07T12:57:20.7128952+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-01-07T12:57:20.7128952+00:00"
}