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": "ff34e5fe-68e1-4416-9ce9-63833297aeb4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1a3a0635-73af-4cab-9eb1-6460eff2390a",
"company_code": "sample string 5",
"company": {
"id": "ecad6d48-6181-4c6d-b95c-86f3fc2957ea",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-05T09:14:36.7550019+00:00",
"sales_territory_id": "0719e1a6-89c9-42c0-add0-68a5f8483ff1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "83a3ce78-f031-4759-bb5d-e45736e660a3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60ee114e-9995-42d8-b3d2-ef99f1a126d6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78e1a46d-2518-4696-aac2-4c419a665fc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef2499ad-5f20-4f8d-aa52-342bc0db3690",
"db_currency_id": "8824c443-68b9-4f8f-92bd-f51c52976c39",
"db_language_id": "16627707-f795-40d1-9f3d-dfb9918ed4ef",
"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-05T09:14:36.7550019+00:00"
},
"modified_dateutc": "2026-08-05T09:14:36.7550019+00:00"
},
"marketing_segment_id": "594c895c-ad2e-485c-885f-411b09b189dd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7ad7b9cd-2b31-402d-87a7-46fdcfd9f494",
"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": "eb1aa28e-c78a-4613-99b0-dfaa89661d0a",
"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": "64cc4215-c396-432e-8efa-30358511c781",
"db_country_code": "sample string 28",
"feelist_id": "6ac7897d-580f-4f3a-ac12-2c179eb9199a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "16df0abd-a206-4862-a3e6-88fc0eb8e1cb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "10c3389d-2c0b-4b45-8932-d896111f2f51",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-05T09:14:36.7550019+00:00",
"db_currency_id": "8eb2df5d-63ee-404d-ba93-15d36168ed36",
"db_currency_code": "sample string 10"
},
"company_type_id": "4bddb40d-4355-4c16-976b-2e35a053d94b",
"company_type_name": "sample string 32",
"company_type": {
"id": "256d14de-14b8-4710-a0da-42a23fbb07b8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c926648b-c1b3-4db9-87fe-60901b4f7534",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1cb90358-e979-4fa8-b1e1-5b492f07a054",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4cabbeaf-3a89-45b4-9c2a-f14cb0936f46",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "902c5478-ece8-4e3e-9317-cc65668f4e6f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "17202627-a7f6-4652-a3a6-b444a7ec1b52",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-05T09:14:36.7550019+00:00"
},
"company_sector_id": "6e3f2946-457f-4c07-a5ab-d2fdf6a389a0",
"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": "30f29903-b77f-4334-ada2-5d49f17e3cff",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "586ef694-458c-4326-91f3-4dd48fa811d0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8612b44f-2bb2-4743-ad10-b4eca157854d",
"account_manager_user_code": "sample string 56",
"company_status_id": "ed8c2c43-7f72-4457-886b-3fd4d65ef2cb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-05T09:14:36.7550019+00:00",
"id2": 60
},
"db_language_id": "803e6c22-08da-4d2c-b83b-50e2f2348517",
"db_language_code": "sample string 7",
"db_title_id": "4553a3ab-c419-49e4-bef5-0229bdf2e274",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-05T09:14:36.7550019+00:00",
"create_date": "2026-08-05T09:14:36.7550019+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-05T09:14:36.7550019+00:00"
}