Retrieves the company 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": "d1624454-dbc1-47eb-a391-ce830c0ac6ab",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "818f5a3a-6b71-4e99-866a-cd01759a9e7b",
"company_code": "sample string 5",
"company": {
"id": "a246b2e8-9458-4921-888f-10f27816afbc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-19T20:26:21.9130259+00:00",
"sales_territory_id": "99b8d42d-fb1d-4834-a2d4-d7af6fbbdd4b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c4fbab75-14b9-44aa-b2ec-8bea91147c06",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "74be0562-9dd5-4c67-a939-d7bfe3737249",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ebdb8c9-e880-4060-9518-5091f5409d8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4785647-5679-4356-9386-abbe24ba2999",
"db_currency_id": "3a2a4347-03e1-47b6-9580-3b287ac5868b",
"db_language_id": "c0647531-e098-4fbb-97fc-d65d4354342f",
"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-03-19T20:26:21.9130259+00:00"
},
"modified_dateutc": "2026-03-19T20:26:21.9130259+00:00"
},
"marketing_segment_id": "f1362577-ff71-4353-8d6d-543c48b4bdec",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "52b7ac55-e13d-4675-8014-44a51a2190e8",
"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": "04ad43b1-bbfb-4662-813a-ecbab8a75c5e",
"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": "34a402f7-0ff4-49be-93ee-e6449896ff1e",
"db_country_code": "sample string 28",
"feelist_id": "16211653-5fe6-4f53-955e-de7e59db7a52",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "939a5d8e-ef8a-4ba2-9d6b-b8b2f4b96d93",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ff698d05-61c3-4d2e-8598-0863b9f2541e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-19T20:26:21.9130259+00:00",
"db_currency_id": "2c4133bc-9d0b-4221-8513-0de03df584fd",
"db_currency_code": "sample string 10"
},
"company_type_id": "dc0db2d3-a9ed-4f96-82df-9db2b41f9bbe",
"company_type_name": "sample string 32",
"company_type": {
"id": "c9ba24b8-2bb2-4274-a60f-5551a0671224",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e96d976-0dbe-404e-8071-fe4b3406b852",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a8e64b7d-4717-49eb-9942-558aba0e4eca",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "78e6e7a9-b83f-4945-877e-305becfce6f6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ea8faeca-2183-4af4-967e-ccf8ee35731f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c0f73ab6-ff71-4d7f-be8c-cd0d9a4592a5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-19T20:26:21.9130259+00:00"
},
"company_sector_id": "0a662bc5-2953-4cdb-86c1-429a1ee75dff",
"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": "86f79548-96f5-44ab-bce3-9c9661944d78",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a80abf19-2aae-4570-9bd8-254de7830fbe",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4c973725-e0ae-4390-a862-5b5ed70cc554",
"account_manager_user_code": "sample string 56",
"company_status_id": "4ee1ae05-ada2-4cc7-8396-4afeae58099f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-19T20:26:21.9130259+00:00",
"id2": 60
},
"db_language_id": "47fe06c9-e39a-443a-b347-9bdfeb48ec1c",
"db_language_code": "sample string 7",
"db_title_id": "4ff49e09-0c99-413c-a54b-1d4a35e38179",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-19T20:26:21.9130259+00:00",
"create_date": "2026-03-19T20:26:21.9130259+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-03-19T20:26:21.9130259+00:00"
}