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": "80ae7d19-bb52-41da-bead-1d499b2de328",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "91b06c07-3de6-4404-976b-fd7270ba235d",
"company_code": "sample string 5",
"company": {
"id": "d1e9ef75-f586-4af6-a2e1-bb380dd32435",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-31T05:26:01.9446065+00:00",
"sales_territory_id": "049cd4f6-e7b5-4f7a-86bd-86297bfde5d9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ca8729c0-b930-48b5-9b67-52d30ad2bd29",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "98f67dda-b907-4e8e-95de-3970250d05f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0371c82e-b34b-4be2-a542-5f30eeda500c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3dbdb85-5190-413c-bc75-36cccdd187b5",
"db_currency_id": "97ad0518-96c8-4650-9cc2-8b4e4a1de046",
"db_language_id": "f986ed3e-8f6b-44ea-b20c-3457c0d90fcf",
"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-12-31T05:26:01.9446065+00:00"
},
"modified_dateutc": "2025-12-31T05:26:01.9446065+00:00"
},
"marketing_segment_id": "fa26862b-ef42-4980-8a4f-512ae558b4c5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8b8b6917-46a1-4173-b9b4-c5682f24399b",
"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": "ba4e21cc-c9ac-48e5-9460-bfaa777790b1",
"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": "6b63b970-1e59-43d2-a879-d394b173e278",
"db_country_code": "sample string 28",
"feelist_id": "7a436c73-a977-4cd5-aa84-6f0d32f9b251",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "58e2da4a-47e1-408f-a311-676a7f362911",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b5fc9b5d-9105-4b04-8c80-31c3031c3319",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-31T05:26:01.9446065+00:00",
"db_currency_id": "dd038597-9cf6-415a-a4b9-14772a058265",
"db_currency_code": "sample string 10"
},
"company_type_id": "f7564403-24f4-4a24-810b-bdf652f85996",
"company_type_name": "sample string 32",
"company_type": {
"id": "7c030cfc-9669-4a90-b7e4-2fc19659948f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "932713d1-7344-4a61-b2ec-f1f91aa7e1b7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f9282cf7-d578-4f8e-9b13-cb492fae92da",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e191eff2-05a7-486b-ae58-0a91fb39eb4c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b2c393dc-59ba-451f-acb4-c7c9f0913ba4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4288917b-f4f0-4bba-a6fb-2f1c8af1eb13",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-31T05:26:01.9446065+00:00"
},
"company_sector_id": "f164bb60-e177-406d-94ca-4e2bcdf751e2",
"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": "4ff13e6e-5eca-4de2-87f4-4d755f4b5b45",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "10d7ecad-1fa4-463f-9cdc-15c65dcc5561",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e6dc173d-c636-49b2-b641-e9cf37a3c38d",
"account_manager_user_code": "sample string 56",
"company_status_id": "14fdc311-e45d-408e-a505-e3d35a404918",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-31T05:26:01.9446065+00:00",
"id2": 60
},
"db_language_id": "6b6dabe2-967a-4bbe-a9c3-ec74f2bad401",
"db_language_code": "sample string 7",
"db_title_id": "3c6e58a7-5369-4f55-9d6e-d3f6e5b29fde",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-31T05:26:01.9446065+00:00",
"create_date": "2025-12-31T05:26:01.9446065+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-12-31T05:26:01.9446065+00:00"
}