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": "fd2b81b7-4353-4c51-b20e-1a9ecc49e1fe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "05995055-df6a-4a09-b7c2-e5cc787b7976",
"company_code": "sample string 5",
"company": {
"id": "edf0c02f-1491-470d-8989-002b30c77d02",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-09T01:49:27.7788426+00:00",
"sales_territory_id": "7cbae2ac-4605-4795-bee8-62b6969c3aa9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6161f079-6651-47fb-87e8-e2721176f62b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "29957097-da37-4214-99c1-ada936ab2c4f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "45bbadb9-247e-4576-ae91-5f75943e8138",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ff41fd-4864-4535-b223-14def0464218",
"db_currency_id": "adf01055-72ca-45cc-9a90-6b5a1c15f178",
"db_language_id": "bcbc1b2b-193a-454a-843d-5ffaede699c4",
"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-07-09T01:49:27.7788426+00:00"
},
"modified_dateutc": "2026-07-09T01:49:27.7788426+00:00"
},
"marketing_segment_id": "322c8283-5e94-4308-a262-12b9fdae990d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fccd727a-6465-41db-9775-bf14b6f5c147",
"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": "6d0ddcdf-ce78-473b-99a5-bf646a13e562",
"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": "41deab90-f1c8-4e0e-99b0-dd4f87baf773",
"db_country_code": "sample string 28",
"feelist_id": "23b401f4-6f22-460b-b004-62778f322ce0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0a7a0939-b3dc-44c2-bfc5-cebcf966de6a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "021fc82a-70e2-4924-ac70-552d17bfa5f6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-09T01:49:27.7788426+00:00",
"db_currency_id": "b4a6a213-8558-4774-a349-1f51c0051f60",
"db_currency_code": "sample string 10"
},
"company_type_id": "3ca747d5-8b0d-4eb1-b818-0632355cab6f",
"company_type_name": "sample string 32",
"company_type": {
"id": "02e9b4ed-39a5-44c5-b0f9-1e6ea09cb96f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4d8a8cca-b21a-49be-abe7-e806961e5ff3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "36fbc516-62be-426c-b452-70ce8537cca1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4658391d-3179-46a1-b263-24f18798cf81",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "81c46b28-a8d5-436a-ae5b-8811464c8538",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b8fab5ea-7980-4d54-8001-d4783ec2506a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-09T01:49:27.7788426+00:00"
},
"company_sector_id": "d08e76fc-6280-4cd8-bf2b-50a136ee0310",
"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": "061669e1-7f1d-40b9-8ead-88c44c05a4b2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9b4be366-c213-4bb4-a732-84fd565e7689",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "994e818f-0566-4cfc-ae9c-257f46a82a8a",
"account_manager_user_code": "sample string 56",
"company_status_id": "464e98d7-9755-4fcb-9835-85986c6c1866",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-09T01:49:27.7788426+00:00",
"id2": 60
},
"db_language_id": "81196f9d-65e8-4487-a1ed-d250a2a4f51f",
"db_language_code": "sample string 7",
"db_title_id": "10f688a3-e4a9-4b5e-985b-2a82d9fd133b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-09T01:49:27.7788426+00:00",
"create_date": "2026-07-09T01:49:27.7788426+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-07-09T01:49:27.7788426+00:00"
}