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": "e265b284-424f-4d06-8ca2-b00d32a40c92",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8c8d71c9-d38d-4d9f-a8c8-da8c072182e4",
"company_code": "sample string 5",
"company": {
"id": "b5ab69fd-9feb-493e-9943-a6675f27eade",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-11T12:46:16.1632211+00:00",
"sales_territory_id": "15686826-11ec-49cb-92fc-05a96d0fde93",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "acdfce46-b918-4d8d-92ae-0421b32fc46f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cdf4994f-918c-4606-80dc-ef141663a809",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a812baaa-d17e-4973-b5e5-1d043eaf4a5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77422762-b562-494b-902c-69f5c677e4e4",
"db_currency_id": "27490f59-7a82-4895-85b6-8eec771c2039",
"db_language_id": "39eda978-1982-41ad-87f8-83277478ccc3",
"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": "2025-12-11T12:46:16.1632211+00:00"
},
"modified_dateutc": "2025-12-11T12:46:16.1632211+00:00"
},
"marketing_segment_id": "7a947bc7-261a-4c4b-a58f-2c47a2ff50c3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d427e3fc-18f5-4f36-9211-6e14ecf66b17",
"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": "a89fa28a-1b40-49c5-a88f-9765c7e4ec80",
"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": "9d38805a-fa2e-46f0-819b-0544dbfc7892",
"db_country_code": "sample string 28",
"feelist_id": "12fe1e2d-e650-41c3-bee7-bcf156849d72",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "56f0e5c8-1751-4eba-b69e-2ffb5c8e3a11",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "54210ee5-eda4-4a1b-9439-6f4e13600576",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-11T12:46:16.1632211+00:00",
"db_currency_id": "507ba334-6c7b-4ed6-8048-db1d102ea32c",
"db_currency_code": "sample string 10"
},
"company_type_id": "7e2221c9-3cdf-4f69-ace9-2c852dd0c8d1",
"company_type_name": "sample string 32",
"company_type": {
"id": "b5432e6c-3c7e-4997-9af4-95903b72f5d5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bbadb2ab-b793-4596-a5c7-0834f6662278",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f539de96-2c8b-47d5-8001-0c188a0c2be3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dee3d174-29db-41ec-a91f-35f98706b77c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "89c32c83-20ac-4eaa-8926-8f1202e5adde",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ba486c2b-8d25-43ab-9689-1d4b80e09e34",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-11T12:46:16.1632211+00:00"
},
"company_sector_id": "1dd7b9fc-8b54-4693-b5d6-fa6e4dee9dfb",
"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": "8ad5759b-f614-4e7d-bd6c-78170323d121",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f6fd60f4-f9e7-4584-84d3-aa22bdfa2a85",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6d49fbaf-f7bf-49da-96ca-4e67f0983754",
"account_manager_user_code": "sample string 56",
"company_status_id": "99cdaa6a-024f-4898-99bb-fe3180762658",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-11T12:46:16.1632211+00:00",
"id2": 60
},
"db_language_id": "8c1b17ff-726c-4461-b73e-05dba7c41820",
"db_language_code": "sample string 7",
"db_title_id": "af40ca4e-62e2-42b0-893c-2a8b316e0869",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-11T12:46:16.1632211+00:00",
"create_date": "2025-12-11T12:46:16.1632211+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": "2025-12-11T12:46:16.1632211+00:00"
}