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": "57d7611f-bd05-4270-8250-e6b3c4f48fcb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e2b465ba-6596-4920-8f15-f9f146e16623",
"company_code": "sample string 5",
"company": {
"id": "fdfe0c07-8f8a-46df-8745-be2c8514ace4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-25T06:07:55.1275635+00:00",
"sales_territory_id": "54316c47-d598-449d-8ec7-221aa3d11ed8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3f228f0a-798c-4548-bec5-51d0b2747a2b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "33d4ff28-eec9-426d-9286-5ff1f68a65dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "455af40e-cbe8-484a-86e9-348f04c7df2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be569f7c-c919-415f-88e8-75b87b5171b9",
"db_currency_id": "10ef96dd-e4c8-4dcf-9de6-ae6a796b1b37",
"db_language_id": "0fe6e4c2-d21c-4f9f-86cb-e2c108b25e9d",
"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-25T06:07:55.1275635+00:00"
},
"modified_dateutc": "2026-01-25T06:07:55.1275635+00:00"
},
"marketing_segment_id": "f4c6d8ff-1b66-48eb-9476-83fa2280a806",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "faae4b1f-7249-4d52-80be-ae0bba5279c1",
"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": "39895884-c146-4b20-9c0d-4e764022f95b",
"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": "12aa848f-7fec-4b15-b43a-65951f62337d",
"db_country_code": "sample string 28",
"feelist_id": "4cfc0c30-f560-4c81-9c01-50e3e49a6982",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "560d66cf-b9ba-4965-97f0-9f589b3041e9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8cdbed4e-a3d1-4744-9f8e-939205175353",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-25T06:07:55.1275635+00:00",
"db_currency_id": "6e2f14b7-6ec9-4be7-b40e-ff460974f5d9",
"db_currency_code": "sample string 10"
},
"company_type_id": "77b27a86-83de-4b64-8610-d482399fa6a8",
"company_type_name": "sample string 32",
"company_type": {
"id": "e1e97ec1-b5a2-4f86-b2a7-d13ac6e81eca",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "08ebd58f-cbe3-4a96-b4dc-ef45ad6ebeb5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3fcf90fb-7569-4f24-aad8-e1191ae86b9e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "075010b6-f448-4e9f-b379-fd3aab3a1ae3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1f067ec7-57b1-453b-84f4-06f5b3207c17",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4919beb7-2a37-4f16-9954-81130e047348",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-25T06:07:55.1275635+00:00"
},
"company_sector_id": "dac6868a-6bdd-469c-ac80-5a8bae49a544",
"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": "c994f592-a91b-466b-adae-2cedba143421",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b1bac032-8267-4a81-9b93-e1054ba85bc5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b216ce19-b85d-4f0f-a3b2-2c67451dcf80",
"account_manager_user_code": "sample string 56",
"company_status_id": "3ee45c0f-34bb-4ceb-a119-8401ab7550ed",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-25T06:07:55.1275635+00:00",
"id2": 60
},
"db_language_id": "a3e4fca2-2742-464e-9ec6-5143b2abdbef",
"db_language_code": "sample string 7",
"db_title_id": "1eecbb71-7bc2-4bdf-bd16-692d04eb8b9a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-25T06:07:55.1275635+00:00",
"create_date": "2026-01-25T06:07:55.1275635+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-25T06:07:55.1275635+00:00"
}