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": "ebf892dc-de9c-4f04-ba95-2e2a028ca809",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6458bcf1-2435-42d4-a91d-1861e6f431e9",
"company_code": "sample string 5",
"company": {
"id": "7be24b0a-ac23-402c-9141-d01c57347055",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T07:27:36.1408804+00:00",
"sales_territory_id": "e23ea98a-15cd-4f43-b319-73050dbe1729",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "638bbd70-fd74-4fdd-bb42-b6781166794c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "95e18f1e-ff56-4b54-992a-1bc90ec421e0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "71efc49b-6857-43a1-8811-1e58d61885cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d3dc3bf-de3b-40fe-9756-7b5c79ca3b98",
"db_currency_id": "811cd555-b9bb-447e-9edb-dee858e5d488",
"db_language_id": "c8b62fd2-c1e6-431c-b93c-ad92827ae272",
"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-08-14T07:27:36.1408804+00:00"
},
"modified_dateutc": "2026-08-14T07:27:36.1408804+00:00"
},
"marketing_segment_id": "66c20369-382b-49fc-90e2-65ad66dab55a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "45576938-c612-49cc-8100-224912ba2080",
"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": "e4afcb2e-6b97-4147-9e7b-61c1d878b187",
"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": "948fdeaa-c40d-4cca-9c3a-647711541809",
"db_country_code": "sample string 28",
"feelist_id": "bc5ad86b-464e-486b-9984-f570072c4c58",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "84ff613f-6db6-4411-8665-fc5a247ffa50",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f021e3d4-5a4a-4dc1-bd4e-66c4ebf74cd2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T07:27:36.1408804+00:00",
"db_currency_id": "6c4833da-da5d-4a07-97ec-b68d9d0ce823",
"db_currency_code": "sample string 10"
},
"company_type_id": "d118fac0-9530-4c21-b175-e2fc3d5b6677",
"company_type_name": "sample string 32",
"company_type": {
"id": "235d04ce-8a29-4e0f-aeb6-b039f05774cb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ade20c17-9afe-4d5c-9e74-b0fa5e7727c8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "301bef8b-b6ae-4cb1-9a17-e1b5c17270bd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1dd47868-2842-490c-8c7a-5ae29907d7fd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6b61b9c3-475c-4da0-801e-73d40fa01bb7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "15e6536b-5423-43bc-9a35-28dae1861149",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T07:27:36.1408804+00:00"
},
"company_sector_id": "977c4622-4b6e-4eee-a3bc-47cbd16bba12",
"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": "25dd24aa-22d1-40b6-83e4-2459c9e8d8a1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eae3510d-8569-4d7c-a146-0c14599f71e8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f11c166f-2bc9-42ef-ab49-37fe905b6074",
"account_manager_user_code": "sample string 56",
"company_status_id": "2b400fe8-3e00-428b-8d11-df5a9760ba28",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T07:27:36.1408804+00:00",
"id2": 60
},
"db_language_id": "9bfe1402-9d48-4f4a-ac71-28182c8103df",
"db_language_code": "sample string 7",
"db_title_id": "3e757ae8-e4c3-4905-aae6-1c205c8d602b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T07:27:36.1408804+00:00",
"create_date": "2026-08-14T07:27:36.1408804+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-08-14T07:27:36.1408804+00:00"
}