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": "c99903cc-3b04-41fa-97b2-582a256d3a4a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bd8dc22b-5903-4444-9a5b-b0710e8778df",
"company_code": "sample string 5",
"company": {
"id": "3bdd5693-f87f-45f3-a88d-d4c28bc2cfd1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-09T09:08:36.4765745+00:00",
"sales_territory_id": "55a30e9e-41b7-49cb-9d73-22955ea37138",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cad54c30-0723-4e4f-a268-7689a31fd0de",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3e09cece-06cf-4eca-afc4-cd8d6449c272",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1a78fda-191b-4769-9dae-5802ae283dbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40dc7e96-9761-4547-842d-0a7ec8d58f7d",
"db_currency_id": "c49c5dee-0b94-40cd-9a80-866beb5ef33b",
"db_language_id": "c469e9e9-e111-4417-a29a-114a486e20dc",
"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-06-09T09:08:36.4765745+00:00"
},
"modified_dateutc": "2026-06-09T09:08:36.4765745+00:00"
},
"marketing_segment_id": "080837ae-330d-4bb1-b90f-557444600c05",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "edbde8e5-a94e-4621-b5ab-241249faf71a",
"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": "d2ac2c19-234f-4c12-b357-35de627eefa7",
"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": "993c1277-4b3e-4719-aea7-55a5e7ebaab0",
"db_country_code": "sample string 28",
"feelist_id": "482cad70-eacd-4922-8941-4e90b8b7a959",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5369c802-aec4-41ee-9b3e-9eca8c9c75a8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0108889b-7e80-49c6-a865-6f83abd347da",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-09T09:08:36.4765745+00:00",
"db_currency_id": "54ca264b-4568-4ad4-8432-107f8a0d20f3",
"db_currency_code": "sample string 10"
},
"company_type_id": "9b24e68c-762e-4cab-a32a-8e43c6b598a3",
"company_type_name": "sample string 32",
"company_type": {
"id": "10389a7c-7415-4b0a-8e5b-cea8c0608ce8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6cc7fbc4-7f69-41ca-86a8-3a977d0c7980",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b211a7fc-f3fa-42de-8a27-c9ebf77a4715",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "73185cc0-9420-4e9b-8ecb-3e74f9ec8cce",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "562ea71f-b1ad-4a1c-a4b0-95645e08c92e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0564e985-8489-43b9-a7d2-f20acb3342e9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-09T09:08:36.4765745+00:00"
},
"company_sector_id": "eac95d83-d122-4643-bce4-524b17e30c7a",
"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": "4799d23d-559b-4b49-a880-f1bd3330ef38",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6407e9eb-feeb-4532-933e-1eb03496e8fd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "daa0ae3f-545f-4aaf-b6ad-b882dd9883fa",
"account_manager_user_code": "sample string 56",
"company_status_id": "5dc7d392-1f84-4ef9-9ef7-ef70bb97a010",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-09T09:08:36.4765745+00:00",
"id2": 60
},
"db_language_id": "c6ed5d09-5733-4100-b713-7ac0d8a348ce",
"db_language_code": "sample string 7",
"db_title_id": "8a495d6b-f941-411d-890c-62d89bd0a8ae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-09T09:08:36.4765745+00:00",
"create_date": "2026-06-09T09:08:36.4765745+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-06-09T09:08:36.4765745+00:00"
}