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": "5c0c53e0-7b2b-47a2-933e-1b3b1da59b9c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b277f949-fe99-4f62-8986-46baf45be8a8",
"company_code": "sample string 5",
"company": {
"id": "743217eb-d442-4db7-9a27-dd06d1291071",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-17T00:53:05.0497095+00:00",
"sales_territory_id": "70feb9ee-30d9-43ec-adab-8910e06f80c7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f713a1c5-78f0-4308-8718-351f9ed42f6c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "402e33cd-027d-4802-81b9-c022a5dfcd20",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "98ce691e-ac60-43e6-ba66-b627971befbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2723529-b920-4bb3-a315-1d2b5a13b609",
"db_currency_id": "9078b39b-6fff-4a18-91c2-baf1226d08ed",
"db_language_id": "574ed26c-d1b7-4e25-b286-16368195ace9",
"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-02-17T00:53:05.0497095+00:00"
},
"modified_dateutc": "2026-02-17T00:53:05.0497095+00:00"
},
"marketing_segment_id": "e796085f-29cf-4273-abf7-9c8188f423ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d9ab05d1-04e1-488c-898f-4d286e1edaf1",
"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": "5ee6c39a-c793-495b-b95c-465d6c56527d",
"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": "e2261dd9-5c87-4e7f-8df6-bcd7bc356e31",
"db_country_code": "sample string 28",
"feelist_id": "8434e677-c74d-41e6-8c3e-a67649360b0d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c92a950f-4cc6-4f5c-a966-157344d73bf2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "17b17a38-9e25-45ef-9fb5-9a4b5d9dc35b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-17T00:53:05.0497095+00:00",
"db_currency_id": "b5f49b7f-fdb3-481a-b5b5-c9472bdaf07d",
"db_currency_code": "sample string 10"
},
"company_type_id": "7c10aff0-180c-4876-b77b-c0cba4345b87",
"company_type_name": "sample string 32",
"company_type": {
"id": "30469caa-7b73-40d1-a3bc-bf0da29d22ce",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "efcac103-2152-4eb7-b67d-a64c1ec0a5d7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4f5d4937-2913-485e-973e-949832399cdf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "296a2527-b7b6-46f8-9823-c20e04099ccc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d40886ff-f318-49d8-b730-7b3a57e44a4c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2362b12d-e5f0-472d-864f-bcc5bd07968a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-17T00:53:05.0497095+00:00"
},
"company_sector_id": "7fd58648-c27f-4f47-a964-668f57cfd7f0",
"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": "5eba96c1-f2fb-4043-b30b-5ce2a6313036",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "44dd77f8-ffa2-412b-8420-75e7bf53aed4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8beea375-78fe-4c00-a00a-8673be2c22c6",
"account_manager_user_code": "sample string 56",
"company_status_id": "77b1e180-44ca-4fa3-89ba-0f7feec74ba4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-17T00:53:05.0497095+00:00",
"id2": 60
},
"db_language_id": "a53ceb06-498c-4c5a-b8f8-ba80fb8c2c8c",
"db_language_code": "sample string 7",
"db_title_id": "df21dcd7-0c76-454a-a486-3a4432fa2ff5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-17T00:53:05.0497095+00:00",
"create_date": "2026-02-17T00:53:05.0497095+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-02-17T00:53:05.0497095+00:00"
}