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": "93cc8c49-264a-46f2-a34b-7f8662c3a6c7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5e3a8a4c-c7ef-4aed-a2ab-c73e3bf87cca",
"company_code": "sample string 5",
"company": {
"id": "fabc1ec9-6a01-44ac-90c5-8bc10dcb812b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-10T12:52:47.1585284+00:00",
"sales_territory_id": "73a5f7b7-bc4d-4249-8572-98c1bd6a531f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ec16af1c-787c-406c-bd8a-28fd79953a07",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed7d7b17-401f-4e56-bd4c-5fcbbf9800e9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c426f82f-936a-48e9-bfc9-98a71e561ade",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1eaedcc4-3d85-496b-9efa-7c123c903412",
"db_currency_id": "21738980-112a-4082-91d8-49b1cf6dbc0e",
"db_language_id": "c760110d-9e30-48d6-bf80-08bcc0fa884b",
"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-10T12:52:47.1585284+00:00"
},
"modified_dateutc": "2026-02-10T12:52:47.1585284+00:00"
},
"marketing_segment_id": "b559c306-3452-4e49-8df7-ceadd0e4ec6f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "25b31daa-be0b-4036-9235-9a418a08aa50",
"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": "dc50d355-c914-4e97-beb2-f09bd619ad8f",
"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": "6c174731-8161-45ea-9c75-f34538c340ac",
"db_country_code": "sample string 28",
"feelist_id": "754dd039-7f40-4b24-8cf6-81430d754558",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "578bb5e6-389b-4485-811b-d7fb41fb8961",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e14bf96b-83d5-4e28-8a8b-018b01ee8114",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-10T12:52:47.1585284+00:00",
"db_currency_id": "ec89b926-b58b-481c-b793-bf4fe1ac17eb",
"db_currency_code": "sample string 10"
},
"company_type_id": "762c381f-fb05-4409-b11a-1ef79c7112ac",
"company_type_name": "sample string 32",
"company_type": {
"id": "e48c2192-c376-41df-990e-2a3baa9a768e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "84644927-2fb2-4bb6-b2bd-5fb67b9a2091",
"sales_organization_code": "sample string 5"
},
"db_language_id": "25badf55-9403-428c-9dbc-8442aaead064",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "23159e63-dfed-4474-90c0-3166edbb76ac",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d7668181-c625-4f41-bb36-496abcafb415",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b520f649-1900-42ca-8426-6f50db0bb64f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-10T12:52:47.1585284+00:00"
},
"company_sector_id": "b890fbaa-b438-4732-ad18-c9859fb9ae2a",
"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": "c106af88-0e57-4994-9441-74975268f811",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4f2f4448-9cd0-4991-a28a-c92343fd2ef9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ac874519-3051-4a22-b136-9256df41d8ac",
"account_manager_user_code": "sample string 56",
"company_status_id": "d68602a3-07a4-4c02-ac20-8aaea0a5efb5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-10T12:52:47.1585284+00:00",
"id2": 60
},
"db_language_id": "18ee5cc0-9d0f-4c6c-bd24-5a9624d94e20",
"db_language_code": "sample string 7",
"db_title_id": "dae68b26-91ac-478c-845a-b016745accf9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-10T12:52:47.1585284+00:00",
"create_date": "2026-02-10T12:52:47.1585284+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-10T12:52:47.1585284+00:00"
}