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": "448457b4-00ab-4d6d-ab77-becc4515ff72",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "662dd02f-a7c2-4172-9b8f-5cfc1ec7ed76",
"company_code": "sample string 5",
"company": {
"id": "731a621b-ab5f-4c05-94e1-5076226fcfa0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-29T13:53:49.6856923+00:00",
"sales_territory_id": "9f18f3a6-5fe5-4c12-9dc5-69d5b7987642",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4e98749c-267b-4485-ba75-6e4b594fa63d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b91bccb9-4574-4ca5-8d4e-126e81332403",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6bbd1a41-9e35-417e-b94d-63def853f447",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e207830-4fb9-4642-83a9-de687011be61",
"db_currency_id": "d64ea2a8-58bf-4858-a52d-1dc6aa2a95af",
"db_language_id": "c32ec4fd-6f5e-4f9c-ae73-b7c54528e7be",
"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-04-29T13:53:49.6856923+00:00"
},
"modified_dateutc": "2026-04-29T13:53:49.6856923+00:00"
},
"marketing_segment_id": "39bcf25e-d69f-4884-8354-cc566cfe0330",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c1cb1662-4636-46d8-af2e-e6bc8a9076d9",
"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": "7bfcb3f2-92e8-4168-a499-78bb88e8bced",
"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": "533b5e1f-c1db-4a1f-91e3-b02efc3b5be3",
"db_country_code": "sample string 28",
"feelist_id": "05565bb7-fe2e-48da-94c5-8a626f898cee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b2ff9027-d1d4-4613-af03-89b0716aac24",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "39032fe9-d998-4404-9d87-499c07fa720d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-29T13:53:49.6856923+00:00",
"db_currency_id": "ec8f6bc8-6b2a-4cce-9cef-151608d4476a",
"db_currency_code": "sample string 10"
},
"company_type_id": "d0e5e124-e402-446e-a246-df58e06cc93a",
"company_type_name": "sample string 32",
"company_type": {
"id": "504e4f01-40be-42e7-91a7-dccdc82eb6b4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de7443f1-57a2-4cb4-8ad5-3acb32c52571",
"sales_organization_code": "sample string 5"
},
"db_language_id": "66000275-b7dc-4d47-a219-19441b65a65f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "737a4cdb-6d64-4e06-98a2-aa6d87354b09",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f99a18f7-b725-46a8-b09f-3e6fcf32d0f6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4c0b43d2-d91e-44da-aab7-7bd80be20f2c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-29T13:53:49.6856923+00:00"
},
"company_sector_id": "2e00fdaf-e1a5-431d-9516-2b105e596dee",
"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": "619ecc2c-fc79-47c6-ab98-b5c346ffcee7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "69c5d3e2-79e5-42b0-8fda-89fd8954129b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "df21c12a-fd15-4f94-976a-30898f3210a6",
"account_manager_user_code": "sample string 56",
"company_status_id": "1f626ab3-382c-4d80-bd68-d88bda805260",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-29T13:53:49.6856923+00:00",
"id2": 60
},
"db_language_id": "67d39609-0ba4-416a-ad6c-52af0c5a9662",
"db_language_code": "sample string 7",
"db_title_id": "0d342f98-278a-446c-a10b-37a46e6749de",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-29T13:53:49.6856923+00:00",
"create_date": "2026-04-29T13:53:49.6856923+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-04-29T13:53:49.6856923+00:00"
}