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": "26587bfb-8dd9-4f43-8253-05764f2e6117",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a13b7f89-ee66-47d7-a657-843943a613ad",
"company_code": "sample string 5",
"company": {
"id": "30397309-2ef4-4692-87eb-4941ee4fe8b5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-15T16:24:24.8515883+00:00",
"sales_territory_id": "f2c071bb-a756-4b16-aed1-7ce5c8036441",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "80909310-1c59-4adc-993a-6f553257f789",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "28571294-addb-400f-93f9-ddb86ac9b64f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6dae4b81-c4a2-48bf-8ab5-9150cfba4cdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af0f4516-db2d-4a99-bc73-9ce60d4578c7",
"db_currency_id": "c89d121d-a088-4717-ada7-c9377395f27f",
"db_language_id": "02f8e834-2432-4f06-8ec9-53524e1d9b28",
"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-01-15T16:24:24.8515883+00:00"
},
"modified_dateutc": "2026-01-15T16:24:24.8515883+00:00"
},
"marketing_segment_id": "d40caa8c-2427-4b25-be73-2c4c0ce1b2e2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0e6ddd99-b279-4c20-aa97-110c46807e0b",
"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": "7e46837b-dcda-442d-93d2-45750e7a6964",
"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": "913c0ad5-5ba1-46b5-b688-7791b0356ff9",
"db_country_code": "sample string 28",
"feelist_id": "5321492b-bc70-48e4-b500-de249d7e00ca",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "764687a4-e659-4f69-914c-da77a06ef423",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3ca48283-a411-469f-b596-4836fec7f2d4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-15T16:24:24.8515883+00:00",
"db_currency_id": "7d07df48-f801-4d70-9ecf-e39306660a3c",
"db_currency_code": "sample string 10"
},
"company_type_id": "90a26d25-1c07-479d-b1c8-a340bd0c05a3",
"company_type_name": "sample string 32",
"company_type": {
"id": "8fa0ac9e-4b34-4252-92f0-f7a3d1020554",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36231705-14a0-4353-bd68-cd8989fdd042",
"sales_organization_code": "sample string 5"
},
"db_language_id": "96833df8-a04c-4db9-bb7f-359cece40a58",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "be530262-4ee7-4eef-ab68-8c3b175664c1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fcaea463-20de-4946-86b0-f4687595a859",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b33c83c6-9ced-4895-a7f7-0ffe88da3843",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-15T16:24:24.8515883+00:00"
},
"company_sector_id": "4a572ad0-800d-47a5-83e3-ee9766e6316b",
"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": "ba13cdfb-fcf3-42d9-b5a8-e2d051e8e2ec",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "358927b6-44f3-4fac-82ed-c6685e1f2947",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9ef53074-152d-4142-af47-a87ef2f165ba",
"account_manager_user_code": "sample string 56",
"company_status_id": "810de5cf-c3fc-438a-9e53-4ba02734bff4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-15T16:24:24.8515883+00:00",
"id2": 60
},
"db_language_id": "c3db02b2-969c-41ae-bde3-dfac6364cee3",
"db_language_code": "sample string 7",
"db_title_id": "6ddf2ada-8431-43f1-a69f-406f837ed97e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-15T16:24:24.8515883+00:00",
"create_date": "2026-01-15T16:24:24.8515883+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-01-15T16:24:24.8515883+00:00"
}