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": "8b206072-0b66-42d3-8b9b-3bc6b4847752",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "10ed4264-d14e-4ed0-bc81-a0cd6230f6a3",
"company_code": "sample string 5",
"company": {
"id": "3c8b5e09-a2f2-4424-9e15-f16c2da36c5c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-11T18:42:37.8298117+00:00",
"sales_territory_id": "4dccbe21-31e3-4eeb-b00e-05a7407993f9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "927657f2-fa98-43ec-9e3f-9067a5b13e2c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "516b1871-3c94-4be7-85a9-cb604041d881",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7a306f3c-4c07-4ffb-a9f7-632aca482323",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33db4d2e-33a3-40b4-a51a-484b3eacffd6",
"db_currency_id": "2531ab05-88cf-43c4-828f-8a933154846d",
"db_language_id": "a1b1b0c1-faf9-4962-ab7d-bfd71193d9bc",
"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-04-11T18:42:37.8454299+00:00"
},
"modified_dateutc": "2026-04-11T18:42:37.8454299+00:00"
},
"marketing_segment_id": "3b2eaa6f-6f43-4c13-9836-2157e9029efc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1ee9eb62-a90a-4c24-b3e0-3102213902f2",
"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": "b0d3a4a0-a2c0-45ce-95d3-15b2d3bedf6e",
"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": "f16d1f7c-5261-4123-98cf-69237f733f8f",
"db_country_code": "sample string 28",
"feelist_id": "b868473e-df44-4c25-b242-3683062f524d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a9e8e39f-6bf7-4e17-bb0f-0b0caf592d30",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "aa95aa30-3571-4d3b-afdb-9bf4f13e354d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-11T18:42:37.8454299+00:00",
"db_currency_id": "fa4d588e-d4e8-4f9a-a924-7857e33549d2",
"db_currency_code": "sample string 10"
},
"company_type_id": "5879bf3f-2b51-4f52-8679-a54266b24aa8",
"company_type_name": "sample string 32",
"company_type": {
"id": "c73a771e-7d4f-4b9b-99cc-754a055cf190",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1d1af363-d50d-46e9-964e-8c61e6f3173a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6a8f463e-3cf3-4b5e-8daf-b6bd93e5e9ad",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4d9525ff-5a62-4c4e-9778-2e76f7c2cec1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2f7945f5-f11c-4732-b19a-8d673b713895",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6fdd052b-4e1b-40f0-8236-ae95ea56877c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-11T18:42:37.8454299+00:00"
},
"company_sector_id": "b08b202e-cfc7-4b5b-9864-9ff5db5d4db5",
"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": "a047b424-4703-491b-85ba-c93a6d9cc844",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "24bd1693-9b30-4fe6-a933-00722d349e9e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2be7ea10-fb32-4bfc-8197-119fb04ac303",
"account_manager_user_code": "sample string 56",
"company_status_id": "467ae099-afc0-4c74-8b2f-88d27c5a45f2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-11T18:42:37.8454299+00:00",
"id2": 60
},
"db_language_id": "a60db2c9-7eb9-4ded-940a-f95611d75fbf",
"db_language_code": "sample string 7",
"db_title_id": "b903a891-153a-4226-8159-1c5e880eaec3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-11T18:42:37.8454299+00:00",
"create_date": "2026-04-11T18:42:37.8454299+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-04-11T18:42:37.8454299+00:00"
}