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": "39682d4e-2e24-4909-b44f-da80f63244b0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "468017f9-a0b2-4da5-a86a-c595127f5db0",
"company_code": "sample string 5",
"company": {
"id": "8ac34284-0876-4c17-9626-f142d1612b28",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-03T20:47:44.3064157+00:00",
"sales_territory_id": "aff93e0a-f0d5-4783-ac2f-a81cf357deef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f7f75604-df26-428b-81c5-92cd0b48d0b3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f171160-5ba3-46a5-bf31-0e4455a50b66",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "94dfbe4a-1f5a-44ad-ac49-4427402bb51d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51d1901b-a664-4d81-8100-00726aa86648",
"db_currency_id": "1ccd8997-152f-42b3-a62a-70671507d3f4",
"db_language_id": "4055cbc5-6354-460c-ae86-78cfdd76177a",
"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-03T20:47:44.3064157+00:00"
},
"modified_dateutc": "2026-09-03T20:47:44.3064157+00:00"
},
"marketing_segment_id": "2786ea7c-0b50-48e6-bc81-ae6ed2dcea0e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "75c2976e-6d5b-4d61-b1d2-99265cb5b93e",
"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": "1cbd2b97-5c2b-433b-8589-564d43a8f30a",
"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": "9de5dd82-552a-4dd5-9945-dceeccc28c90",
"db_country_code": "sample string 28",
"feelist_id": "a8dc8be7-753a-42b2-b923-1c02d07eb84b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5b6daf57-c816-4235-a524-353361cd7100",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e23f6463-09b7-4077-b2d0-4803c82c1623",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-03T20:47:44.3064157+00:00",
"db_currency_id": "e9d5aed4-6504-40f2-9938-201a7f1c01da",
"db_currency_code": "sample string 10"
},
"company_type_id": "4da30df1-e46e-4b14-b92c-cf87b9a304a3",
"company_type_name": "sample string 32",
"company_type": {
"id": "0c5ce611-19e0-4c7d-b9cb-faad077fa3fa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "249f5f75-3be6-4d0d-83fb-6918dac1a6dd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1dec1b1b-81db-4748-8109-07d26899ae4a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f0df501b-f1f1-44e7-b8cd-79c5972a0d0f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cb693f7e-e0a8-44ef-b687-a564c78fe7a2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5fd8ff32-8df1-44d5-b1a9-75b8ddefc0e1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-03T20:47:44.3064157+00:00"
},
"company_sector_id": "4627718a-2a32-41b8-8f75-76e7069cc5cf",
"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": "59ce0c83-56e9-4c06-8734-6c04518c0c9d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1055f7a9-9f1e-41fa-87a0-cb51381e0948",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7dcba3e7-13ea-45ec-8512-a51ab5d667cd",
"account_manager_user_code": "sample string 56",
"company_status_id": "fcd67e75-a9fc-415e-a1ee-5329f8f6d2ee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-03T20:47:44.3064157+00:00",
"id2": 60
},
"db_language_id": "12ebbff5-4853-4c6c-b286-6f0066dfe99a",
"db_language_code": "sample string 7",
"db_title_id": "ca9662f0-92d1-414f-832e-d4c109c80acb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-03T20:47:44.3064157+00:00",
"create_date": "2026-09-03T20:47:44.3064157+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-03T20:47:44.3064157+00:00"
}