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": "fe13d569-f16a-40d1-b735-c6420d5f522d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "92ad6142-44a6-473b-8c02-eefa330b660d",
"company_code": "sample string 5",
"company": {
"id": "3532640c-8758-4cba-a1d8-6f025bddebfe",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-07T18:45:09.6222399+00:00",
"sales_territory_id": "76a7deb4-b4d6-4da8-9807-12767c196e50",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1d228a76-33b9-4ce4-9153-caf32b95c9d9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "714df6a4-de8e-49f4-8929-137c5dc12395",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5973af8b-239d-455c-b426-f1ec61576765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df6366b7-3391-458a-ad9a-5150c8852664",
"db_currency_id": "a2a45543-99ca-42d2-9022-446d2f7be829",
"db_language_id": "728fa453-ab11-45dd-8cc2-f012ee7b0b59",
"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-07T18:45:09.6222399+00:00"
},
"modified_dateutc": "2026-07-07T18:45:09.6222399+00:00"
},
"marketing_segment_id": "45ac123b-dd72-4267-9ad9-227fe2303b8e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "13df7580-d840-4565-9560-4ef8935d3824",
"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": "e6490559-03a8-4e0f-be8a-11a1e09eaa7b",
"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": "dbfc03b1-e00c-47e4-9167-5103892ae5e1",
"db_country_code": "sample string 28",
"feelist_id": "06c8c6a9-2fc2-4b48-b57d-d2b463438e6e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "16a5c303-32ea-4049-a5ff-da241829b153",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cab622ac-a357-4eb1-9cfc-c9753c8b6ca1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-07T18:45:09.6222399+00:00",
"db_currency_id": "24c8ff35-a7fc-482f-a85e-f6f1ae301fc8",
"db_currency_code": "sample string 10"
},
"company_type_id": "f5d18c54-6297-4e05-83f1-1dcfef1f3326",
"company_type_name": "sample string 32",
"company_type": {
"id": "9b8091bd-0ebc-4f77-b3fd-5f90679f21c9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1f121a32-eb52-4ece-8346-c8a8ae2a5863",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3b9f0089-5dd7-4a65-a137-c2f7489fd193",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cc74a938-2171-41b5-a055-4b28383e2be0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "876b463c-6056-47be-a54d-5534c4e28500",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b7fa1413-b141-4410-be3d-94db11cadf78",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-07T18:45:09.6222399+00:00"
},
"company_sector_id": "09fd4d8c-d6ac-440d-a6cc-73a90315f5dd",
"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": "b9991f08-5f39-41b6-be19-f0ea34d087a3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b37bf80e-b2d8-427c-9333-003ade3a049e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "65104aee-c03c-4d87-8ce1-67c6806f95cc",
"account_manager_user_code": "sample string 56",
"company_status_id": "3be0077a-3ba1-472e-bba0-4a54bcf844f2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-07T18:45:09.6222399+00:00",
"id2": 60
},
"db_language_id": "cce3bddb-5d29-4f22-b886-0dafc50c6c89",
"db_language_code": "sample string 7",
"db_title_id": "5b2aaae6-abba-4772-8364-a7978a80897a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-07T18:45:09.6222399+00:00",
"create_date": "2026-07-07T18:45:09.6222399+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-07T18:45:09.6222399+00:00"
}