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": "eee820f0-5659-4e19-aa56-69a023bb1b32",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2d5a5f52-bc0e-487c-9787-8845b54c48bc",
"company_code": "sample string 5",
"company": {
"id": "7c33fce2-7a61-465e-a78d-4fe167c98fb5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-02T04:45:31.9254446+00:00",
"sales_territory_id": "23406313-8232-4861-808a-3cc672cd5390",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9cc99906-4797-4d5e-8b3a-a21c0407a5df",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "17cfadb0-fc50-4e41-8101-5d7a41f3e3f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d5c0f6e-f1c4-4a89-ae2c-f76785e7e5b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2da4255-acf7-43bc-bb61-77d270488f39",
"db_currency_id": "6d4e081a-c552-40d6-930e-1f9f88e82f7f",
"db_language_id": "526876d5-f82a-4b77-b905-40e22dbe65a7",
"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-02T04:45:31.9254446+00:00"
},
"modified_dateutc": "2026-05-02T04:45:31.9254446+00:00"
},
"marketing_segment_id": "a3ac2442-4c80-4f67-984e-965ab629b8db",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "15ab8285-bebc-4185-b21f-70a96fe97461",
"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": "8055d7c5-56ed-48cf-87e7-1c603b95c143",
"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": "09027b95-74e0-4d2e-ab52-00bd4bdf053f",
"db_country_code": "sample string 28",
"feelist_id": "2c2b05b8-49d4-4a25-9f3f-4ee6ed1fca1b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "98af8a61-cc84-4d46-8167-9cb1e1b7fc45",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "26c156be-58bd-4160-9e00-2cf18217fa7f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-02T04:45:31.9254446+00:00",
"db_currency_id": "5afb50e0-0bf2-4072-ab71-9fc3e0067b9f",
"db_currency_code": "sample string 10"
},
"company_type_id": "777f40af-25e1-4ea3-8090-c7037280c855",
"company_type_name": "sample string 32",
"company_type": {
"id": "2dc3969b-de42-4ce1-8ec9-8ad2019816a1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36ee0222-2b73-4bec-9e66-b6a96e44ec72",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b61a5de0-dac7-4eca-8686-31d3698a49d2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7f80a994-d43d-4911-8d90-12e7e72d0f18",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8aac3724-5837-47bc-ba71-7e889fbbe55c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ec84c1fa-c032-40d7-85e3-ffdf7b84c484",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-02T04:45:31.9254446+00:00"
},
"company_sector_id": "38752d2b-d364-465d-8320-2a272cf061c0",
"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": "dc766b53-7a0e-48fe-ad5d-8b68eecd25a5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "66c4050e-8fac-4395-9050-797a6b336749",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ff364cfc-3932-4580-a922-ec741ecdd441",
"account_manager_user_code": "sample string 56",
"company_status_id": "eda88d64-8b83-4da6-9788-da8ecc84f126",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-02T04:45:31.9254446+00:00",
"id2": 60
},
"db_language_id": "e12d930a-0d0c-4ad5-adc7-cbc360cf5bad",
"db_language_code": "sample string 7",
"db_title_id": "591f6876-d163-45a9-b441-27aecb1ca6c9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-02T04:45:31.9254446+00:00",
"create_date": "2026-05-02T04:45:31.9254446+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-02T04:45:31.9254446+00:00"
}