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": "e63d9df7-adf1-4b04-b9c2-cd6b71b886bb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2865547b-c965-483a-8962-c0f4cf1b47d2",
"company_code": "sample string 5",
"company": {
"id": "7ff6faa4-d996-456f-81c0-221068d8bfbf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-14T11:24:57.0072886+00:00",
"sales_territory_id": "cbc6f0d5-2dda-44bf-89d9-bdd4ee03b6d4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b32f09cf-4b1a-4534-86d0-529c0deedd1c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c5db9640-cd60-430b-9216-e5730f2b7d42",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "db0556de-055d-48d5-bf14-814b1ec9931f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fdbd48eb-040c-4033-8d6f-723ae9fb5df5",
"db_currency_id": "3b8b4b21-28c3-48bf-a270-e54cf1de63e3",
"db_language_id": "afc6e369-3ae9-4072-99a3-1176bd2d4b57",
"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-10-14T11:24:57.0072886+00:00"
},
"modified_dateutc": "2026-10-14T11:24:57.0072886+00:00"
},
"marketing_segment_id": "24658625-a7de-433f-a272-46fb387d647e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1cd97b80-94e9-4127-b6d6-5b4e47bb4796",
"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": "f83df2c2-e301-48fd-9312-9484ddc025f3",
"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": "a99ba03f-bd35-444b-9e85-450d5f2efe8c",
"db_country_code": "sample string 28",
"feelist_id": "b37e42d5-04be-4ef1-9153-6bcb6ad2ffb4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a4c58945-1e2c-4825-b760-eb05875100b9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8feb6115-8ab8-4fc1-ab2f-88a9815290ec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-14T11:24:57.0072886+00:00",
"db_currency_id": "250a5d10-3734-46f7-b736-c10a34336580",
"db_currency_code": "sample string 10"
},
"company_type_id": "dd0c503e-3f2f-4771-a2f6-b9846b8fb88c",
"company_type_name": "sample string 32",
"company_type": {
"id": "9e14efa0-df44-4f7e-ad11-817fb0870cf7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c20e87af-1c23-400b-a3b0-bf68d333d432",
"sales_organization_code": "sample string 5"
},
"db_language_id": "45dd0aa1-f6c4-4dc0-a259-ac0d5fa03380",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "01b873e1-f404-412c-ba4b-4d3b8783aa6c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "324a42cc-a0b9-4b0a-8633-a2eb8910f946",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f1b8ebef-231a-4a08-8965-1924f1f16b10",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-14T11:24:57.0072886+00:00"
},
"company_sector_id": "0074a99c-c80d-442b-91e7-f43e079e7ff8",
"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": "fb407dec-e508-4bc4-928d-5438d2ad2de6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ea5f49ae-fc79-44e1-a57f-aa16ffc962a1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7bdf378c-897e-4215-b317-6ca354e270cd",
"account_manager_user_code": "sample string 56",
"company_status_id": "3fd1c65c-5522-4002-a03f-ade26213a2b8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-14T11:24:57.0072886+00:00",
"id2": 60
},
"db_language_id": "d20983ee-34d2-4ecd-8f27-4b45bf540d96",
"db_language_code": "sample string 7",
"db_title_id": "7fbb27be-a570-4043-bf38-00c4fe352cac",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-14T11:24:57.0072886+00:00",
"create_date": "2026-10-14T11:24:57.0072886+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-10-14T11:24:57.0072886+00:00"
}