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": "498bd244-41d1-46a5-b71f-2939105de23a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d66a735b-0497-45e8-b4b5-e704c145f3f5",
"company_code": "sample string 5",
"company": {
"id": "ae82395c-ebe9-4459-8287-772dd7d1a788",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-31T13:21:32.838725+00:00",
"sales_territory_id": "18b6e6da-392f-4a7f-884f-ea003fbe0678",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cd05f12f-7774-4880-a2f9-7add5e3106e0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e625c6f1-7898-4f3d-8149-39a1e5dea4ef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ff51d815-9067-4a2a-9673-1b44ef26d9af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12b86995-60c1-4c3d-9044-8576502fd85c",
"db_currency_id": "34e8668d-f080-4cb1-9b58-2916a8fabb75",
"db_language_id": "23ba710e-9c6d-4c8f-81d9-1ebb50809e1e",
"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": "2025-03-31T13:21:32.838725+00:00"
},
"modified_dateutc": "2025-03-31T13:21:32.838725+00:00"
},
"marketing_segment_id": "46cb10cf-232b-462b-9828-98d80d478d16",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "72efdbe6-1c06-4105-9c37-25c2a46f01ca",
"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": "c9a5e490-b25d-4c0b-9e4f-4ace134caf78",
"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": "0e51cf78-80d9-46b4-b771-7d86a2101751",
"db_country_code": "sample string 28",
"feelist_id": "c5f1b6ab-71a9-40fc-868d-8cd2b45581ae",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "834c4e4b-649e-4a89-9a98-19b9f49812f7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fb20e8d9-b617-4bc8-9fad-803237aefaec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-31T13:21:32.838725+00:00",
"db_currency_id": "791d1fd4-0081-4159-b0d9-fcd2f83f993e",
"db_currency_code": "sample string 10"
},
"company_type_id": "4141e336-9e2c-47cc-b7b0-2888f4e483f7",
"company_type_name": "sample string 32",
"company_type": {
"id": "18e58f31-4611-46b1-bbb9-f8addd79fa82",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9984358e-c5ea-4894-a037-856e05e0741b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f356d186-d013-4012-a661-114fb9024102",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6fde0c09-a1e1-4de8-8934-b055bf8421b6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b0f8112e-2155-4628-ab96-c0611df72811",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "24ab19f6-7264-4323-a8e9-3b08ec20ee11",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-31T13:21:32.838725+00:00"
},
"company_sector_id": "3d6e84f4-e9fb-4512-becc-23439776a10a",
"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": "35930484-6dac-45f3-bf23-b5e3b84c3635",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8eddd325-e0ae-4d17-a8c5-753a220b04d1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "926ab170-5da5-4b38-b9f8-da1c9cd47456",
"account_manager_user_code": "sample string 56",
"company_status_id": "66f511c5-73c3-476c-b84f-90bb22499aae",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-31T13:21:32.838725+00:00",
"id2": 60
},
"db_language_id": "3ed35901-e790-4046-a925-7f457952af4c",
"db_language_code": "sample string 7",
"db_title_id": "d9946e9f-b28f-4517-a8c4-d0741f7e7b12",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-31T13:21:32.838725+00:00",
"create_date": "2025-03-31T13:21:32.838725+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": "2025-03-31T13:21:32.838725+00:00"
}