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": "be5ca3c6-0d52-47df-bcbd-699a0906ff5d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "51590928-9179-4164-8890-73f43e93dfb4",
"company_code": "sample string 5",
"company": {
"id": "b435a3d5-9458-45f7-b099-82668fffc4ab",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-18T19:48:40.3091261+00:00",
"sales_territory_id": "ef69f817-2622-476c-8769-465af9b06855",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2079d7a8-aea2-4954-a0c9-a55c05f5a97b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8091e441-bdb9-496f-8802-5d3522d3c7d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c792a128-16e1-491a-83b6-8d70f6728c3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3841e68-1e85-4f92-8db8-448fe7984c81",
"db_currency_id": "5cb13f34-b6d2-45de-a129-917f66466ab9",
"db_language_id": "d29be063-a40f-414b-ace1-727ec5dbc2c3",
"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-18T19:48:40.3091261+00:00"
},
"modified_dateutc": "2026-01-18T19:48:40.3091261+00:00"
},
"marketing_segment_id": "ea24367c-0238-429f-9658-e3154fc8b49c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "889a2415-ff54-4762-997b-bae406bb4051",
"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": "cb9c2d0b-748f-4465-ae74-bceaa9c1f39f",
"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": "c5464702-3866-4a83-8330-d14bbb040af9",
"db_country_code": "sample string 28",
"feelist_id": "db8055e2-818f-4aa3-a096-a6b344b9e216",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "273802ce-ce05-48a6-bf07-0798711983b2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b6df30d3-4b48-4299-813e-02532e44b4c2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-18T19:48:40.3091261+00:00",
"db_currency_id": "6a9c613e-3918-41d1-b215-d56deb895f9a",
"db_currency_code": "sample string 10"
},
"company_type_id": "cf03860e-bcfc-4230-a2a6-6ea24a19378c",
"company_type_name": "sample string 32",
"company_type": {
"id": "01419650-bf99-4ca0-a93e-adf857b3dc32",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "230e1216-863b-439c-ae0d-5095f5697442",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c21a9eb6-2578-4caf-b014-5aec8306d5a4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a8fa2918-ca30-44dd-8962-9a22db9be73d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "202870f5-78c1-4669-b5f7-a9441f019479",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0b3d6aef-d2e4-4047-8fe0-cac00a5abff8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-18T19:48:40.3091261+00:00"
},
"company_sector_id": "a6de348f-f56e-45b8-863f-1488c7b299bd",
"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": "ea7fef69-1f6a-4f8f-bbfc-3a1b5cb217ea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dcf12134-e927-4968-9801-c51e8710b087",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b0db3a4c-080b-4146-8fdd-84b3bac9a7d2",
"account_manager_user_code": "sample string 56",
"company_status_id": "8213843f-6fdb-47a6-91b5-6640d3abb222",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-18T19:48:40.3247477+00:00",
"id2": 60
},
"db_language_id": "b8d14291-8d10-452f-ae14-265c172468ae",
"db_language_code": "sample string 7",
"db_title_id": "df86148f-72f2-48c9-9f10-44cc432c969b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-18T19:48:40.3247477+00:00",
"create_date": "2026-01-18T19:48:40.3247477+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-18T19:48:40.3247477+00:00"
}