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": "cc40a775-f5a1-445a-9b4f-d3032947c0d9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "772ec526-9abf-4051-9f63-ab4ef167d537",
"company_code": "sample string 5",
"company": {
"id": "c998057b-1d2f-4d7a-aff5-2b69e36ac9cd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-30T17:10:30.1428461+00:00",
"sales_territory_id": "0fcbf8b4-d617-4935-843f-a325506f54c9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "959ba475-19a6-4275-8fef-95ddc8783581",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58fe1e03-7afc-4b10-8f97-1df257ad1c77",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "14c945f7-ea06-4a16-a24b-67f491c782cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95f35eeb-7849-49fb-90ed-799279ca0449",
"db_currency_id": "4d1eb8e0-714c-48c1-a336-d24c889413e2",
"db_language_id": "e4422e1c-0d45-4422-8864-83d8940ba28b",
"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-30T17:10:30.1428461+00:00"
},
"modified_dateutc": "2026-07-30T17:10:30.1428461+00:00"
},
"marketing_segment_id": "677080f3-a712-435d-8fd2-40c89f21a562",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0086d3ea-6da9-451f-98e2-abbe19a685bf",
"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": "49b94f2e-0b00-4b97-bfc9-0ee5116a3a95",
"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": "dafaa800-ce3e-4cad-8c81-f07e1cbf468a",
"db_country_code": "sample string 28",
"feelist_id": "b84b7275-bb36-4085-a082-401b7af80c64",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a41e4fc6-79f7-4c0a-a6ba-5ceb3b50b930",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "97e1a8c0-ddac-4abc-a4ae-eb68809bb24a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-30T17:10:30.1428461+00:00",
"db_currency_id": "d6a3d0f2-4403-4c42-a24d-31fddbeb0a42",
"db_currency_code": "sample string 10"
},
"company_type_id": "e8a8aba3-0705-4d2b-89f7-664285366437",
"company_type_name": "sample string 32",
"company_type": {
"id": "231318aa-efe5-4941-b40a-8b5185775e4b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "59b0bc5d-e8f0-43ea-aa1e-787141cc3027",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7e7afc08-b1f6-4dbf-8028-e3436fc194af",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "adb27976-983f-4cbe-97af-7b0f9795a67e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "caf1e3e8-844c-40bc-9088-0333610c2afc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "40b37ba0-4f57-463a-9976-61b96eb90f00",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-30T17:10:30.1428461+00:00"
},
"company_sector_id": "b640b6c7-b074-4388-95c1-23f78dbbf01b",
"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": "a7abd7d4-f567-466a-ab9e-61e49174059a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "adb4b95c-311c-4c60-bc8e-f8b5e666446f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f8c731f2-79b8-4f6d-a264-91a45ee277a4",
"account_manager_user_code": "sample string 56",
"company_status_id": "e9d608cb-8817-489a-a8ee-992cc963acc2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-30T17:10:30.1428461+00:00",
"id2": 60
},
"db_language_id": "9fbe6514-4b8a-4f34-b08b-88540ba9dddc",
"db_language_code": "sample string 7",
"db_title_id": "d6de2a49-bfd9-4a8c-b10b-9e7ceef93fae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-30T17:10:30.1428461+00:00",
"create_date": "2026-07-30T17:10:30.1428461+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-30T17:10:30.1428461+00:00"
}