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": "f86b4ac4-97c1-4b7a-b06c-6a1530977210",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "47920af3-989f-4700-bdc6-5b54bb957363",
"company_code": "sample string 5",
"company": {
"id": "0c15b1a8-738d-496f-a1ad-42ec79c56ee9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-27T20:53:49.2085163+00:00",
"sales_territory_id": "17eeb531-f0d6-4cfe-90d4-95676ead5553",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "12c62a0c-c131-48ed-b8b8-133f865cf1d6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9f8e430e-b19c-432c-98a3-e4f9c8750066",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b2cca4a9-ec32-4893-a979-e3cbc88549c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90880898-0f10-4d94-adad-f047a27ddfff",
"db_currency_id": "8188e91c-5f33-47c6-8c6d-07b787092674",
"db_language_id": "7c802e32-7c45-45a4-af51-df78b22a32ce",
"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-08-27T20:53:49.2085163+00:00"
},
"modified_dateutc": "2026-08-27T20:53:49.2085163+00:00"
},
"marketing_segment_id": "9f66c62d-3c20-4f00-ad1d-64021c196a28",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1d5f90bd-26a1-47d4-92e7-3849cd90f645",
"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": "c06a6a5d-4dbf-4d30-86e3-ea18aa1d8fe2",
"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": "1fa23e7c-c2bb-40cb-90a8-268642130549",
"db_country_code": "sample string 28",
"feelist_id": "98727652-cbee-4e63-8503-7ca5a9021949",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f3e58e48-a78f-4548-98fc-555a3815b39c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a6d20b9e-d272-4309-b04f-241eb4857f6f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-27T20:53:49.2085163+00:00",
"db_currency_id": "8727e86b-e5cf-4ee1-9758-c221f8d70dcb",
"db_currency_code": "sample string 10"
},
"company_type_id": "7d9ec9bc-8700-4ffc-860d-8e6f61f70793",
"company_type_name": "sample string 32",
"company_type": {
"id": "c2282168-208e-4ff7-a6b5-347a63e4fb65",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "94b3e038-1099-4319-9aab-d8def2de5308",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3d1142c5-15f8-4e38-94d1-4b71a649f6f4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "17134d17-3000-4868-9f84-7b67273773d9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3a421a10-d927-463c-b0a3-78095e808766",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ccbb35c2-4e0a-4ad8-a855-fb59a77678cd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-27T20:53:49.2085163+00:00"
},
"company_sector_id": "a3100367-6c76-496d-a55e-5a51606f2b92",
"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": "ed0ac8ef-b057-4c24-9d33-8abdef71c23b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5c8451b0-0a79-4baf-b811-8bf53006e3e2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b7c3f511-ba07-426e-823b-30e17a592ce0",
"account_manager_user_code": "sample string 56",
"company_status_id": "70f566c4-81a6-46ad-846d-e0c864dc83bb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-27T20:53:49.2085163+00:00",
"id2": 60
},
"db_language_id": "020239a7-f8de-4897-b2ce-064e30d75e17",
"db_language_code": "sample string 7",
"db_title_id": "7b8adf69-01bf-41e8-9d28-df4a20036e7e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-27T20:53:49.2085163+00:00",
"create_date": "2026-08-27T20:53:49.2085163+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-08-27T20:53:49.2085163+00:00"
}