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": "58db11fb-2af6-43ba-ab63-c6bd0efe174d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "534f669e-d998-4abe-979e-11ee1940e193",
"company_code": "sample string 5",
"company": {
"id": "e6ba62eb-3a5d-40c5-91bd-9e47aeeb92ed",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-05T18:24:47.6247393+00:00",
"sales_territory_id": "25d6ce36-83e8-4656-aa67-ec351a2c1259",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f6d1c517-6bee-4878-9b1b-91524827a58a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "689c68ec-9c02-4eea-92e1-c533f6cbce38",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "756e5731-8cc7-4d11-baa6-e22d3f48cfe0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9849a33-1cda-4522-9b53-39680c3303ee",
"db_currency_id": "c4b74d69-e591-405c-a722-fabe6b8442ba",
"db_language_id": "e69b78de-cec1-4c98-acf0-be48a8775959",
"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-06-05T18:24:47.6247393+00:00"
},
"modified_dateutc": "2026-06-05T18:24:47.6247393+00:00"
},
"marketing_segment_id": "0daee8e3-38d2-4284-8a83-fbcc05f645cc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f34b9071-df61-4583-a490-b51daf2dd5fc",
"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": "46103fa9-f63f-4575-a777-5089e578c18f",
"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": "4f715ec0-a69a-4898-ba93-527aef8ce4d3",
"db_country_code": "sample string 28",
"feelist_id": "ce55ac15-edd7-4bc9-95c8-82c784c1d3f9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b87856f7-bc3a-4d65-8022-d6830819cd6f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "369c616c-fb23-4a24-8a3f-eacd9ae0ffa0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-05T18:24:47.6247393+00:00",
"db_currency_id": "4a098a36-a39a-4bf5-979b-a877e27e8517",
"db_currency_code": "sample string 10"
},
"company_type_id": "2681f8b5-8da5-4e34-a729-0844d720b7d2",
"company_type_name": "sample string 32",
"company_type": {
"id": "d697cc90-b276-47cf-af2a-649cfcc19737",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bca4c957-ba02-4382-8781-d18c9c6e5df7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af69d83e-2aec-4fb4-83f8-af72f2415e89",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "71c90bc4-9d0b-4fdc-9810-0a4290ab08bb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "be9db9cf-82fb-445a-b609-5a475c2d768c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c5feaaee-7f41-41dc-854a-96803e46e6a4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-05T18:24:47.6247393+00:00"
},
"company_sector_id": "5391e729-5774-4a9b-a376-a0084126e7bb",
"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": "46c80634-0bec-4b22-b0db-b040052c235d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "56727bd3-97e6-43ea-bdfd-ce0b2e07cf5e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9a8e0661-7151-4d72-b06d-3f47ccb87db7",
"account_manager_user_code": "sample string 56",
"company_status_id": "fb97ce2d-f169-44c0-a7b7-87446a8ea787",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-05T18:24:47.6247393+00:00",
"id2": 60
},
"db_language_id": "e0269301-bafc-4903-b20e-7c693789a1e0",
"db_language_code": "sample string 7",
"db_title_id": "78a26f2a-d565-4420-8e69-8fa664fb82f9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-05T18:24:47.6247393+00:00",
"create_date": "2026-06-05T18:24:47.6247393+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-06-05T18:24:47.6247393+00:00"
}