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": "2709bd7a-1db1-4fc6-846e-bd7ff0fcef0a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f3fbdc52-4220-4e55-ac6c-26cc383d6779",
"company_code": "sample string 5",
"company": {
"id": "8ce01f6e-5af8-4ea5-8d65-2db526241d66",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-09T06:27:46.1005569+00:00",
"sales_territory_id": "faf18474-8f29-4726-b1e7-1737e1d22d53",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d926e9ff-d754-41ce-9575-06891d1873ec",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e862d9e1-7056-403a-b885-a6f8c4a074a2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "79f9016f-ef67-46ae-90ce-595e6439b40b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "25268562-993a-4550-a671-d1df56155295",
"db_currency_id": "ff5e09ef-bfaf-4049-8f86-30a32d65291c",
"db_language_id": "0c3de1dd-3427-44fe-a0cb-492e51f32180",
"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-07-09T06:27:46.1005569+00:00"
},
"modified_dateutc": "2026-07-09T06:27:46.1005569+00:00"
},
"marketing_segment_id": "79eb0704-025e-4b1e-a3bf-2015ea6fd28c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ce0cd203-0cbb-4953-b498-832ddd240258",
"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": "2905c4de-3cc0-47ef-a3b9-948e845e212d",
"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": "8a8ca9dc-ba46-4971-86cc-24931c561a7d",
"db_country_code": "sample string 28",
"feelist_id": "9f2f1091-1de7-4fcb-a28c-d70ad44cbd14",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cb1473e4-19da-4215-ad54-37d9a7783c9c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8a9dfe60-7a22-4c2b-bdae-c94e8b1cab2b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-09T06:27:46.1005569+00:00",
"db_currency_id": "b9954e75-c5d0-455d-a71d-e533dde18a8d",
"db_currency_code": "sample string 10"
},
"company_type_id": "44d66557-5f0e-4cb4-9f86-32c1c9a6415f",
"company_type_name": "sample string 32",
"company_type": {
"id": "92e98420-92c3-4fca-9707-e4b8c90025e1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "32c62b4e-38f0-4da9-a9b1-79892d282ee5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "37f70b55-af36-4aa0-a0f4-f4c6f5a02747",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1a67b8af-908f-4be6-a4d5-60ccc42021da",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "289b696d-f9f8-49ee-903c-b9531698f57b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2c616beb-abe1-4b99-bacc-7b54a1aa743f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-09T06:27:46.1005569+00:00"
},
"company_sector_id": "d5b039ba-58b9-4ee6-b17e-8a6cf47958a8",
"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": "9c1730fc-efb3-45d5-824d-a3608f92a868",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "91c4159b-3a1e-48d4-ac4d-8a9e24a7be56",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d4b32656-7df6-448a-be98-f43b861d6388",
"account_manager_user_code": "sample string 56",
"company_status_id": "bb8acc41-976e-41be-a935-9a2615d9f87d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-09T06:27:46.1005569+00:00",
"id2": 60
},
"db_language_id": "51b7bf20-b4fa-48f2-ab31-f122ad9eb8c9",
"db_language_code": "sample string 7",
"db_title_id": "1f85a933-6efa-470c-b49a-8019ea6ffda7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-09T06:27:46.1005569+00:00",
"create_date": "2026-07-09T06:27:46.1005569+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-07-09T06:27:46.1005569+00:00"
}