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": "6e10c4d6-b9f3-4102-ad6c-bba38c298041",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "196500c7-90b1-4677-9f94-83d032544699",
"company_code": "sample string 5",
"company": {
"id": "f4e1991a-00c9-4421-b995-97cf6f8cae85",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-27T07:15:32.751487+00:00",
"sales_territory_id": "dd32637e-c992-4d50-b1d5-980e372c87ad",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "06a29e4e-b441-4171-8332-927345d99ce5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eafbae9a-9077-4c77-82d9-a1a497337a1b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4aafb2a5-1d54-427c-8192-5e937484fbfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "407d0a7a-b243-461c-9828-dcbbb5d2f003",
"db_currency_id": "ef0fb6e1-d25b-4d1f-ad37-f095dcd2cf5a",
"db_language_id": "a76edb76-14ad-419c-8b94-8331c497fa25",
"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-27T07:15:32.751487+00:00"
},
"modified_dateutc": "2026-07-27T07:15:32.751487+00:00"
},
"marketing_segment_id": "e1340e58-f09f-4fa1-880f-93eb1cfeff2b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fa5bfec0-6ef3-49bc-b4f1-180d690e1a3d",
"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": "c34ece6a-2c7d-4aaf-9bc2-970600f45e3a",
"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": "93569ef2-d5d2-4aca-aa4a-3c805d89b8e8",
"db_country_code": "sample string 28",
"feelist_id": "07d4996a-92a9-4dd2-98f2-08d8fbf80e6a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c75ab6cf-3590-4113-b436-96b34b9afa02",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ef9da3a5-23b4-4870-bfa0-01ee4d600ae5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-27T07:15:32.751487+00:00",
"db_currency_id": "8748ecbd-00de-468e-b5d6-38c9793a99f7",
"db_currency_code": "sample string 10"
},
"company_type_id": "15e9cbce-72ad-4903-9516-a2587f4bba87",
"company_type_name": "sample string 32",
"company_type": {
"id": "46abfd23-ffcd-46b5-992b-024f0ca40f4f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bef03a3c-5330-48ae-ad5c-119ab95e538b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4bcad875-98a0-4d45-97a6-e97b9963044e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "11053a25-a6b0-40e1-8773-f3ca7590e9b0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b2b9b514-84eb-4c05-913d-ab03561760a9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "859691d0-0e29-46ba-bf95-091a871dfae8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-27T07:15:32.751487+00:00"
},
"company_sector_id": "a17dd154-b803-4b9d-a530-827da816a216",
"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": "886cae3f-838c-4ce3-8b82-e79650ae0aca",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ba554dcd-6600-496d-8eb4-139089d40da8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5d665452-938a-4aa5-a38f-2d6c42024bb3",
"account_manager_user_code": "sample string 56",
"company_status_id": "e65fc8d0-1f3c-4265-822c-abaaf760660e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-27T07:15:32.751487+00:00",
"id2": 60
},
"db_language_id": "be8e83c3-4b1b-4659-b200-9fa320f04f48",
"db_language_code": "sample string 7",
"db_title_id": "faf4afd5-5b4e-4c4c-9a6f-abb864be86d5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-27T07:15:32.751487+00:00",
"create_date": "2026-07-27T07:15:32.751487+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-27T07:15:32.751487+00:00"
}