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": "0c2c26b2-7c7f-4771-b31f-b0f60386e2d8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e520cf19-317a-474e-93af-6499ef69941b",
"company_code": "sample string 5",
"company": {
"id": "ccbeeb46-ea20-4cde-bd11-ccc8a6104d67",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-11T21:39:49.1524837+00:00",
"sales_territory_id": "adb63284-c518-43f7-a5fa-91164a85d954",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "43192fd0-11fc-4607-ba4f-18f9fc743444",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8603fbb1-92ec-490d-979a-518420d966de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0e8f9a17-dbde-4a93-aa6f-1c0fe083d40c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "039e844b-72f9-4ff9-8c14-61183c81c3a5",
"db_currency_id": "a504e42d-1cb0-4dbe-be5f-16cd9923ba78",
"db_language_id": "e420b4c2-8d27-4cbc-ba0c-86de8cecff1f",
"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-11-11T21:39:49.1524837+00:00"
},
"modified_dateutc": "2026-11-11T21:39:49.1524837+00:00"
},
"marketing_segment_id": "48779def-fb2d-41a2-9f57-3149c36ef13f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dd3518a1-15c0-4f1b-8cbe-96026c1c7fd8",
"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": "c9553c8b-6517-40ee-908e-5e9f77add060",
"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": "fea358be-cc38-431c-a157-00ced541d46e",
"db_country_code": "sample string 28",
"feelist_id": "f0a46816-6756-4090-b82f-4eb2e49bfde0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c48e5a53-982f-402b-a57f-aac1fa667799",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "016f7d8b-1074-4810-8c4b-230457d55d10",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-11T21:39:49.1524837+00:00",
"db_currency_id": "a2701b63-6fcf-47ce-afd8-4351d2619881",
"db_currency_code": "sample string 10"
},
"company_type_id": "e6ef5bd4-1f11-470d-9794-36d17cade969",
"company_type_name": "sample string 32",
"company_type": {
"id": "5a21e309-4518-4461-a00b-2210f81b66ee",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e014dbd9-b471-426c-ad7d-1108dcdd4a6d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dfbdd12a-76c3-4057-b471-ac4bc0f29949",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9dee0017-0792-4ab7-80fd-86fa9ccfd9ba",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9a17cd6f-cf9a-46b8-b6c6-cc610fbe2c81",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3982fb45-ac94-4d41-a9a1-c8bb949e5012",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-11T21:39:49.1524837+00:00"
},
"company_sector_id": "68df9152-df7d-4dc7-a16c-ccaa8275e0e9",
"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": "23e2b76d-8893-4d76-bd83-71ec334ea9db",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2f720c02-11f3-4737-afdd-fe8250bb02b1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "87be4dff-25ff-4d02-ae3f-db3d56104579",
"account_manager_user_code": "sample string 56",
"company_status_id": "94b2edcf-c081-41fa-aa2b-df3633263f9b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-11T21:39:49.1524837+00:00",
"id2": 60
},
"db_language_id": "fe7dd78e-b2a6-4987-9018-70bcf4b117ab",
"db_language_code": "sample string 7",
"db_title_id": "dba133e4-7551-4b39-bd90-ad3df3fe47f4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-11T21:39:49.1524837+00:00",
"create_date": "2026-11-11T21:39:49.1524837+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-11-11T21:39:49.1524837+00:00"
}