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": "52ccbd5f-ae2b-40c6-81a4-02be65004c6e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7300d5f4-f958-45eb-812b-240650eb9876",
"company_code": "sample string 5",
"company": {
"id": "290e2d7c-e471-4107-942c-67157fb28369",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-07T23:46:46.1358002+00:00",
"sales_territory_id": "b62f28bb-2579-4a1d-8fba-a592aeb4985f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d3341b90-af7e-4a58-b5ab-69c9e6ee4411",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6cddd123-6def-41d0-8db3-8867458cf336",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0c1a19c6-b2f6-4234-adca-1bc39394bdc1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6f7a315-90f3-4584-965b-31d3d3baa1e0",
"db_currency_id": "685282d1-2878-4d77-9fd9-1aa311a51a72",
"db_language_id": "c244a036-ca02-493b-bfae-cbf975e5bfd3",
"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-09-07T23:46:46.1358002+00:00"
},
"modified_dateutc": "2026-09-07T23:46:46.1358002+00:00"
},
"marketing_segment_id": "43843977-1996-4ab1-a1ee-2135ffc777f2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5af325d8-7f17-4cad-a7a8-53208d15f98f",
"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": "95cb1dd9-b5c6-4f2f-8585-447fbcb6f3bc",
"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": "ccf86c89-252f-4509-b303-75c583407a3a",
"db_country_code": "sample string 28",
"feelist_id": "76c3cddb-323f-4f3f-8f5d-2f1097e97e6e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8ba47cb1-3b78-4d85-842f-88558cbbb03f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e1fde99b-7d51-4ccc-b34b-afb72818dc30",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-07T23:46:46.1358002+00:00",
"db_currency_id": "98a3ed6f-efcb-40df-b730-e75eb11fb311",
"db_currency_code": "sample string 10"
},
"company_type_id": "426505ae-e5c3-4e4c-be6e-5cecfbf1d6e7",
"company_type_name": "sample string 32",
"company_type": {
"id": "efdf54b1-28a8-44a4-9a0a-0b8bca8584fc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4b6506a8-8e23-491e-bbb3-cca2b0ca17da",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6f609cce-d50b-475d-b2e4-e4dc7d61451a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4494cf04-c38b-4887-81d6-6b5daa79bf16",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5d4c990b-d776-491d-9bdd-17cc4f0749e3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "58614c2d-564d-4053-94e1-db506e5ab9cb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-07T23:46:46.1358002+00:00"
},
"company_sector_id": "1ebb2a85-2eaa-4ca9-a60a-a0e3af5c5b7a",
"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": "c527c04a-1c51-48ca-b93f-03c654a766df",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1839fd4d-2350-4b50-90ae-3c7fdd05bc2f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "45a802c9-2f02-4160-b0ff-26124e03424b",
"account_manager_user_code": "sample string 56",
"company_status_id": "324372fa-8891-4e81-859b-1e063a4850ab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-07T23:46:46.1358002+00:00",
"id2": 60
},
"db_language_id": "b6e9f83c-3437-4b1b-abdf-22e2201174f5",
"db_language_code": "sample string 7",
"db_title_id": "f938a9d7-33e1-4556-b872-0580c5f7e0af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-07T23:46:46.1358002+00:00",
"create_date": "2026-09-07T23:46:46.1358002+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-09-07T23:46:46.1358002+00:00"
}