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": "a1ab7ed8-4e96-4338-8256-b40ff476c7b4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d0ed1b03-8050-4ebc-90f0-2ab91f23f8a5",
"company_code": "sample string 5",
"company": {
"id": "533d9536-5d03-4876-beb2-df6b18a53701",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-16T15:22:46.422986+00:00",
"sales_territory_id": "54f51216-2f33-4a58-a7fc-143b63d594d9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0a109745-7ec0-44f8-8900-60df783ded93",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2be95fef-7c77-491b-bffc-79d206abeda2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bb4e1829-235b-4550-bc2c-c24fcef03c2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb34267b-5763-49ca-908c-f8f59d15131e",
"db_currency_id": "c047ae74-e513-498b-9c29-a919ebab4a19",
"db_language_id": "dd90006d-bb7b-4666-9f2c-c7a1d76b6f76",
"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-05-16T15:22:46.422986+00:00"
},
"modified_dateutc": "2026-05-16T15:22:46.422986+00:00"
},
"marketing_segment_id": "77ab7700-2958-42f7-ad1b-12662878b893",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4db9d34c-26cc-43c7-8dd5-8ac2d80d13aa",
"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": "ae19afb8-9229-4e00-ba6a-5b00f70ed2b1",
"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": "a2c27065-fe56-4c38-b55c-97422265fd60",
"db_country_code": "sample string 28",
"feelist_id": "3c9c87ad-9c71-414f-9ea8-728239882fed",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "49d4f99d-9e6d-4c23-b590-129bbc7ba0e7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6ed0423f-287c-4c0d-bdc8-57b91b0212e7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-16T15:22:46.422986+00:00",
"db_currency_id": "ad81b8f7-7b43-4e35-9b33-ffdacb445fe0",
"db_currency_code": "sample string 10"
},
"company_type_id": "c29e6a54-9e09-42a6-835c-8ef2c5020325",
"company_type_name": "sample string 32",
"company_type": {
"id": "c722eadc-f0c1-44c7-b207-024cf49354a3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "09577e83-0fe3-4fc5-8543-d4d4bb7c8780",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a374ea76-65a0-4c6c-9ba6-fbe543fcea5b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6fb1290a-6589-461b-83f1-e89022430486",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7cadc0ac-5262-4c31-a57c-c071717743fb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b8445b2c-e4b0-476f-aa9d-5ca98759e70d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-16T15:22:46.422986+00:00"
},
"company_sector_id": "47e96f8b-d0c7-48b9-8e2f-69ef8fd358bb",
"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": "8c83ab33-91df-4a3d-8251-5aa7c02382c6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b93fc23e-b767-46d1-b917-dc6b38a5aeda",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f0f64071-451b-423f-9e74-2a04f02f097b",
"account_manager_user_code": "sample string 56",
"company_status_id": "dbf79c4f-6ecb-48d7-a7c8-0ac6c453b65c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-16T15:22:46.422986+00:00",
"id2": 60
},
"db_language_id": "58935012-c8c1-4f07-a4f8-5db61fdce424",
"db_language_code": "sample string 7",
"db_title_id": "c6f5bd78-362f-409a-b9eb-83ee4398ac31",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-16T15:22:46.422986+00:00",
"create_date": "2026-05-16T15:22:46.422986+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-05-16T15:22:46.422986+00:00"
}