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": "ae4d2be0-7753-4294-a096-d17c0899f247",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d39f9237-95e6-4940-99d6-303c8afd9fa2",
"company_code": "sample string 5",
"company": {
"id": "4ef8acab-b576-4c4e-8b05-7ab20f41ed08",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-15T03:06:46.8037601+00:00",
"sales_territory_id": "19b7419d-01d2-4653-9df4-2dacefeca4c7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b35d429a-e087-4ab0-a739-db887a1a4e35",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fac8e240-58d5-4815-8423-1ea98d32004c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "50aec280-452f-4316-baf4-49d180efe30c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eedcb93-b8d2-4471-b758-73becb0fcb21",
"db_currency_id": "9f75d5e6-aa51-4d71-91f0-f61b0282111a",
"db_language_id": "1c69d51d-ad68-4017-8e09-9dfff6e4e8e7",
"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-07-15T03:06:46.8037601+00:00"
},
"modified_dateutc": "2026-07-15T03:06:46.8037601+00:00"
},
"marketing_segment_id": "6527d1e9-84ce-4390-b652-07d8a7b051a1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "67ea3da5-ecf9-410c-9bbb-e42e0da68ca9",
"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": "6b7daded-3494-4efa-bcd0-7d874d2611c8",
"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": "a78b8604-2bd0-4f6a-a30b-b0948872c82b",
"db_country_code": "sample string 28",
"feelist_id": "ef9b4323-0bba-4a4f-b45b-df1338b49744",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cb502e79-187f-4285-9654-be50d33484c7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "57f002ed-0c02-44ad-98f0-9faf1f2381cd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-15T03:06:46.8193884+00:00",
"db_currency_id": "3c24e94b-dce4-46ce-bf60-8b9434b33f52",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2c139c0-baec-457f-8d32-cfefabc272f4",
"company_type_name": "sample string 32",
"company_type": {
"id": "d225c686-66fe-4fbd-9a42-7df12e0c99cd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3d4cc879-9d5f-4815-94a9-38f4995d56c1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5ce01b55-ae69-442d-9604-30ecab994e61",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cf53afbc-388e-4bf6-8107-5df931c84806",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "48ac5db6-fdf8-4940-a714-c4ebdbbb3098",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6bde771a-2839-4f26-b4b1-c6d59df573be",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-15T03:06:46.8193884+00:00"
},
"company_sector_id": "c78a07ce-9afb-47c4-bff0-def83cddb658",
"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": "2d9014aa-f725-4d62-b45e-f1d885f2c5c9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "522a365b-e380-449c-95e7-449ab62c8eac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "426f0b3e-ccf6-423b-97d8-df93e6dc8cee",
"account_manager_user_code": "sample string 56",
"company_status_id": "2bb61a7e-a8af-4c3a-b682-73ed22577a39",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-15T03:06:46.8193884+00:00",
"id2": 60
},
"db_language_id": "20f44a7b-2db1-4429-b170-14e89c49bea1",
"db_language_code": "sample string 7",
"db_title_id": "2627ae70-550d-4275-a6f1-467149a46c81",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-15T03:06:46.8193884+00:00",
"create_date": "2026-07-15T03:06:46.8193884+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-07-15T03:06:46.8193884+00:00"
}