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": "f1795087-3999-45e5-bd42-7fa3e898839a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7b651298-3e42-4cd3-8cfd-39d950c56a65",
"company_code": "sample string 5",
"company": {
"id": "55c142c0-e129-47b7-a27a-d0b32b98ebf7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-25T05:51:30.4245174+00:00",
"sales_territory_id": "626235b5-4a80-4265-984e-4ac0404177e2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b59bd69a-3251-4b1b-b04f-cbc39535c9ba",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b2cdaef-8d31-44d3-b942-dc2a2f226d63",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aadec106-4a4a-4933-baad-9198a573f743",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63e33b3c-5ede-472d-845e-1760fa9d9b09",
"db_currency_id": "12206811-176f-4f8e-9f0b-4130dbbeb2ab",
"db_language_id": "d2a45a70-f6a8-4bc1-8f8c-91b7e7cd101e",
"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-25T05:51:30.4245174+00:00"
},
"modified_dateutc": "2026-04-25T05:51:30.4245174+00:00"
},
"marketing_segment_id": "06603087-384b-476f-96b0-41093e4a6ef8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a9a51f37-35d4-499c-80cd-a5002f7807bf",
"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": "ad31972b-6ef4-47a8-8ad7-7edaea5c2489",
"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": "8c07d0f2-4150-4a3a-9321-0bbd077c975c",
"db_country_code": "sample string 28",
"feelist_id": "e3526871-54d8-462b-8864-cb31b89c53dc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2c64b019-226e-4b42-aba7-bce8cf373ce9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c3c15bd8-ef88-4035-b609-5fe321bb3e34",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-25T05:51:30.4245174+00:00",
"db_currency_id": "e3a6fc18-05f2-4935-aa15-96c3c49a871f",
"db_currency_code": "sample string 10"
},
"company_type_id": "94b56054-e68f-4cea-98bb-08c0180f7c7f",
"company_type_name": "sample string 32",
"company_type": {
"id": "c885a3e2-12f3-41b0-8eaf-6f1a1d58fee6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf6ace28-64c4-47a0-8abd-2e2d54f14aa6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ece8cdc2-aae0-4739-9137-2f18989aa4d1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "20c5a511-dbce-412d-bbc7-e8d81809db73",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d2054d9e-4635-468c-89cd-62dfe984a9ba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "09dce1e2-2fa6-4439-b3d7-4e785a6dcddb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-25T05:51:30.4245174+00:00"
},
"company_sector_id": "de88009e-d330-4064-b7c8-7b993d24ac92",
"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": "4dd792d6-4f85-47c0-a71e-9f287256c9e5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "de71525d-a070-44fe-a8e3-acd4426b8a63",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "28937789-fbef-4bf1-9669-96052dbb3a45",
"account_manager_user_code": "sample string 56",
"company_status_id": "b32a66dd-7f95-45e2-b88b-4f4c45767bc9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-25T05:51:30.4245174+00:00",
"id2": 60
},
"db_language_id": "66508df0-aaac-419a-a646-325740536c30",
"db_language_code": "sample string 7",
"db_title_id": "882abab5-3a06-466e-813e-e2d4b7057f2c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-25T05:51:30.4245174+00:00",
"create_date": "2026-04-25T05:51:30.4245174+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-25T05:51:30.4245174+00:00"
}