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": "9a75d845-1b52-4ec0-83f6-82c956798b61",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0d3e7d82-dfeb-4904-8fd2-e09e6ffd89f1",
"company_code": "sample string 5",
"company": {
"id": "6809073f-c283-406b-adbd-a31ded5c2587",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-19T02:38:39.7137505+00:00",
"sales_territory_id": "b2a99f42-a62d-4391-91c0-567b473242a1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eae45d58-70d8-4452-8e3d-7590538acfe3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af463661-79bd-47e1-8d72-1dc031b303f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "087644c5-b2e2-4207-ba89-86c614a8c216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12542c36-479d-47a9-8fd0-81943ca9de20",
"db_currency_id": "2415b41a-573a-4d6b-b392-4464fe418471",
"db_language_id": "9ef4804e-2204-49a3-810b-e35777af19d1",
"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-19T02:38:39.7137505+00:00"
},
"modified_dateutc": "2026-01-19T02:38:39.7137505+00:00"
},
"marketing_segment_id": "934487d5-6734-4dda-a714-50dc3ca31512",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c6881b8a-a3c7-4c77-a2e8-c6839df97ce5",
"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": "750a8588-872f-4364-b8ea-5ea7588bead0",
"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": "0ea8a860-6811-444c-99b3-cb927be96007",
"db_country_code": "sample string 28",
"feelist_id": "48b342cd-43d7-4797-b13e-a7c30164f1f7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fe1227f8-64f9-4d59-b98a-f4baa52ab033",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e56f50eb-0dc3-484a-a23c-a0037ef532e7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-19T02:38:39.7137505+00:00",
"db_currency_id": "fcda948b-3937-4bc3-989f-75ffdaf3cb7d",
"db_currency_code": "sample string 10"
},
"company_type_id": "2139e444-9076-4618-873f-b2530d44a367",
"company_type_name": "sample string 32",
"company_type": {
"id": "2819a117-ce0e-4216-bcfd-acc5d7b3cd93",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0c9878fc-682d-4918-bff4-6531fb365fe1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cda796c9-38a8-42f3-9dcd-e69978b8fcd1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f39116bc-310a-42ed-a7ca-e30c3257059d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "da887471-3bc5-4230-832a-833b91fdcccf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "71246038-a0e7-41ae-af9b-7ffefd26105e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-19T02:38:39.7137505+00:00"
},
"company_sector_id": "a4f9e5f3-ae8e-4748-ba70-9098bbfc147f",
"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": "1c2b2629-7b4d-412b-882c-26eef0a29322",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "80dffd90-9805-438c-bd11-7a6369af7c4c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "db05860c-36ee-4489-b4e2-5adb53fad506",
"account_manager_user_code": "sample string 56",
"company_status_id": "43314c65-0b76-4ce7-a359-d91e00b8ad0d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-19T02:38:39.7293663+00:00",
"id2": 60
},
"db_language_id": "6e30ede0-ef19-4786-9ed3-d2eec773d4f4",
"db_language_code": "sample string 7",
"db_title_id": "fa70dbbc-a66d-4c35-ba0f-5920a6b4f8a6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-19T02:38:39.7293663+00:00",
"create_date": "2026-01-19T02:38:39.7293663+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-19T02:38:39.7293663+00:00"
}