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": "3bd83a9d-0533-4ff2-932e-a8c7bd22edc3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "074fe8fb-d5de-4a79-9870-7edb3ed646a7",
"company_code": "sample string 5",
"company": {
"id": "a268f0bb-59a3-45b6-b1de-8e6296f6222f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-14T00:27:36.5715535+00:00",
"sales_territory_id": "2042f7f0-5b5c-40ef-a268-a21398e62f3a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "663a0959-6016-478f-a0fd-5131ac066a8e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cf061493-78eb-4d3c-b23b-26c264dfe24a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7fa3429a-cae5-40bf-a6af-d2ae89496736",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d43e090-7ec9-4d41-9b6a-4cd63012030e",
"db_currency_id": "dff32ff4-a904-4f92-90ef-21534e99cae0",
"db_language_id": "27862410-417e-4301-86e5-c5974631d939",
"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-09-14T00:27:36.5871735+00:00"
},
"modified_dateutc": "2026-09-14T00:27:36.5871735+00:00"
},
"marketing_segment_id": "10f41b2b-f327-47c3-b067-03cd67009357",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4b72be22-0ae6-451c-976d-bf23ecec5e8f",
"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": "8252f319-ac14-42c3-b0af-80461908dac8",
"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": "69ba7054-d64e-4ad9-b235-f12cc4e3770e",
"db_country_code": "sample string 28",
"feelist_id": "87093451-6fb4-4295-823d-f57c7f5482cd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "910c4332-0fc3-4c45-b9f7-20dc52950c92",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "69de4125-a642-4603-80ef-b7056784d656",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-14T00:27:36.5871735+00:00",
"db_currency_id": "c25d051f-4584-4ec7-a849-6453b2610aae",
"db_currency_code": "sample string 10"
},
"company_type_id": "1c696657-83ed-478b-876c-13b724c44c0a",
"company_type_name": "sample string 32",
"company_type": {
"id": "2b48d792-5fd0-41fa-b851-81a2e7f4b8ac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "96b949e7-73b8-4df6-a501-5e82bda26ddb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7b4f9c08-59d8-4a57-acf9-e1677a769e20",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "979c3f01-9197-42cb-be58-1a82925ab4e9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a3611fcf-0552-45a8-b9de-46c0425e6b81",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e960ed38-b8cc-4341-8a86-b23b327f0641",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-14T00:27:36.5871735+00:00"
},
"company_sector_id": "d051d0eb-dc78-4af3-b95e-b147bf71e66d",
"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": "4ba0ff11-c907-486d-88d7-6768fea31263",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7b11b0e7-74c6-4259-8403-df9564384609",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4b878504-fd6e-4afb-ab11-8ae679f2f954",
"account_manager_user_code": "sample string 56",
"company_status_id": "1839941e-a880-4e5c-80cd-b593b7fcade8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-14T00:27:36.5871735+00:00",
"id2": 60
},
"db_language_id": "d4ab18eb-ce28-4c08-9f24-b3914440b291",
"db_language_code": "sample string 7",
"db_title_id": "25c9e147-b0f6-4d22-ab67-b09e4a26f1d4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-14T00:27:36.5871735+00:00",
"create_date": "2026-09-14T00:27:36.5871735+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-09-14T00:27:36.5871735+00:00"
}