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": "d373022c-9593-40e9-81c0-2925d544aaec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8d7e5824-a62c-4fc9-8cca-5d790a8581a7",
"company_code": "sample string 5",
"company": {
"id": "bad2f25b-5356-427a-9595-d6cb24960184",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-23T06:34:23.4573883+00:00",
"sales_territory_id": "17b1db12-541d-4165-94de-e3e2b5e1026c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "12624cf9-d07f-40b1-b7e7-48dba1e26202",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "87eafe07-da9b-448e-bf76-4a4a800c1d21",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "658f3d20-2347-4340-8cdd-2f85eed72307",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a9a8228-c93e-4f01-9b00-ee4814628446",
"db_currency_id": "0bb1e685-5760-4376-880c-be3b19260896",
"db_language_id": "b7de4486-c67c-4aad-8154-6bc01006553e",
"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-10-23T06:34:23.4573883+00:00"
},
"modified_dateutc": "2026-10-23T06:34:23.4573883+00:00"
},
"marketing_segment_id": "2392521a-cc01-4427-9256-8dbf6c288516",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4c48523e-a7d1-430e-9ff8-bd62f190f272",
"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": "ef83e50f-6a2f-4e3f-b295-664ea81675a7",
"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": "1e3dc1c0-6bc3-4920-b0bf-2e2587841534",
"db_country_code": "sample string 28",
"feelist_id": "cfc997a3-4c57-4c42-b90c-bb5a111734e4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "04ab1ed5-faee-4d33-bb6c-406c585fd3ca",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0e66b44c-77c5-449e-a774-d78c4232986a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-23T06:34:23.4696474+00:00",
"db_currency_id": "bf43ac13-6ee7-4d55-b07f-f2fa9c291fc5",
"db_currency_code": "sample string 10"
},
"company_type_id": "1122125d-839c-4b55-b6cb-e2e93c91039b",
"company_type_name": "sample string 32",
"company_type": {
"id": "f6b0f26a-6490-4d75-9834-b27b03802429",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dde2b673-733b-4ecc-9c0c-25252c03df36",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a8867f2d-1572-4df0-b8be-36e632980064",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "371d3097-bef1-4e35-8fd5-73bdce8fb018",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1b771867-2bca-4bc3-80e5-6dbf6e03a469",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "26def672-04ee-4b9f-b517-4a40649752e2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-23T06:34:23.4874044+00:00"
},
"company_sector_id": "5fffa76e-c20a-4def-a2d3-4ee8c8ba0946",
"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": "9e4f3991-27c5-4d3f-b3c2-0b5798843512",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "da63da38-974b-46a0-9195-fc773402d498",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "31edb9a9-7422-4a4c-94d4-5b4b92483c9b",
"account_manager_user_code": "sample string 56",
"company_status_id": "0e4581db-d429-42b3-804f-a027ed7d8846",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-23T06:34:23.5008977+00:00",
"id2": 60
},
"db_language_id": "0bc98dd8-fb01-462b-af73-e84af3600e30",
"db_language_code": "sample string 7",
"db_title_id": "7fd59235-f861-480d-97f0-13f2fead8b71",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-23T06:34:23.5008977+00:00",
"create_date": "2026-10-23T06:34:23.5008977+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-10-23T06:34:23.5008977+00:00"
}