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": "e024262b-2a5f-43fc-b134-93d4e6d1b825",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8acf96d2-0d4f-4317-962f-5211ea3e099a",
"company_code": "sample string 5",
"company": {
"id": "8a20f2b0-8ff1-449f-9fcd-10327e72d643",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-16T05:55:21.1491357+00:00",
"sales_territory_id": "5a3abc05-3622-472a-b16c-fe06b07680c0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "84e97895-d965-42ef-b2dd-fd46313b9609",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b37dd9f2-d129-4ea9-96d1-394822da9efa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5db6e4fa-0bfb-492c-92d4-f5ff6d1f6f91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c624b736-5ccb-4b52-87da-3753a10f8bb5",
"db_currency_id": "fe3f95b6-bfe4-4629-9d30-1af73dd5f2fa",
"db_language_id": "b1a02a2b-ebbc-4d4f-9cb5-e9bcb35ad3cd",
"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-16T05:55:21.1491357+00:00"
},
"modified_dateutc": "2025-12-16T05:55:21.1491357+00:00"
},
"marketing_segment_id": "d70e9514-e836-4872-a78b-852abc82a9c2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6a8f1ec4-1a7b-4663-b567-794e63195a13",
"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": "e7a642e2-1729-4a00-9fca-3a1f24bda81a",
"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": "7134af8f-9093-4126-8e46-720c1b6f1389",
"db_country_code": "sample string 28",
"feelist_id": "71d05647-5e92-4d95-8d5a-d0870cd2b50a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5bb91ce2-a9ca-4e41-a124-1d277056bdad",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0f4a72ab-ef94-46fc-80b6-e30d65bf2367",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-16T05:55:21.1491357+00:00",
"db_currency_id": "e81ae389-6134-4239-9a7f-fac9cc6424aa",
"db_currency_code": "sample string 10"
},
"company_type_id": "272f1f48-38f3-48ee-b161-2d276f481cfc",
"company_type_name": "sample string 32",
"company_type": {
"id": "c6880d9e-4452-4c1f-a7b1-8e388518fe82",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ee8fa95e-d51a-4a98-aad1-cc3e2bde5a87",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f8c60dc1-0c22-4349-adee-4c44591e2648",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "28e6db86-a230-4187-b4f6-4a3b0fe93c5d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "63dae325-f2b2-4426-a3f8-6ee79c000ef7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "67abcb94-2b18-44ed-8f94-bd75e5548e63",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-16T05:55:21.1491357+00:00"
},
"company_sector_id": "32a8267a-517c-4335-83b5-e79ee43bb89a",
"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": "8dbcf848-7a9e-44af-aca8-8d3c0d009600",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0989aaf-2952-4d63-ba2a-65fa8e23552c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d8ba2c2d-5aa1-47c8-873a-c78924457b1a",
"account_manager_user_code": "sample string 56",
"company_status_id": "20e28f42-b70a-4d4d-bd23-4e6499140dcf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-16T05:55:21.1491357+00:00",
"id2": 60
},
"db_language_id": "b52141f1-60b1-40d7-949d-d03d485cc9c5",
"db_language_code": "sample string 7",
"db_title_id": "bb6cb77b-47d7-4b81-8c3a-8554f910baf9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-16T05:55:21.1491357+00:00",
"create_date": "2025-12-16T05:55:21.1491357+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-16T05:55:21.1491357+00:00"
}