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": "5c7032a1-3e33-4fec-acc3-9de6d74bc3ab",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f5e01429-58e8-4205-bc16-b4d50e32d122",
"company_code": "sample string 5",
"company": {
"id": "09973b6a-be4e-47f8-bf4b-11f07f9d3b46",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-15T23:32:42.4020078+00:00",
"sales_territory_id": "b2d960ca-f003-4f98-8505-6ae7e28fe04a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5cbe8cad-9f5c-43c1-8846-415fd9aa3829",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "17b09ff9-6957-4580-9851-f341e9f8fc48",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f896f4d1-dffa-4df5-ad95-7e9a93df6c6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8538406a-8b88-4348-82b8-797c4d3efbf2",
"db_currency_id": "1424b446-7593-463c-9368-10c0741890bb",
"db_language_id": "39c7b4e7-f5bd-4572-9613-c7cb15e8a630",
"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": "2025-11-15T23:32:42.4020078+00:00"
},
"modified_dateutc": "2025-11-15T23:32:42.4020078+00:00"
},
"marketing_segment_id": "43aa06d7-dbe3-4136-879a-de3bb3cd0556",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "446fa516-c215-4f9a-ae6b-e3d7c7316afe",
"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": "df0ad7f4-2a11-41c7-a28e-8bc1d5ff23c1",
"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": "8969f6c3-4401-4610-9c4d-71c84eb8284a",
"db_country_code": "sample string 28",
"feelist_id": "3cabf3cf-d7ef-41da-86e8-934a1353b972",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "49e54185-d8e6-4728-b96e-653d338cd5be",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8cc2cf70-a0ae-4275-a496-db5dcf2a8c97",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-15T23:32:42.4176324+00:00",
"db_currency_id": "c20a93f6-c144-4950-9f3b-7e1b92e5acab",
"db_currency_code": "sample string 10"
},
"company_type_id": "e0087c23-ebc6-4598-a8b1-979b7b034853",
"company_type_name": "sample string 32",
"company_type": {
"id": "7add3ddd-55d3-45f0-8a17-1213c12ffb71",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fdcade3a-3db6-4cd2-a8c6-2d62ab7f411b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "079fff25-bfd7-4d31-9caa-688824f1862b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9ead6509-e13a-432c-b7b5-92bbc2007bc9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9dd1f1b7-1e08-4b94-b960-4f174e81fb15",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9e498ce1-80c3-484b-a1ef-26c0345e0ff3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-15T23:32:42.4176324+00:00"
},
"company_sector_id": "848d4dbe-3025-461e-857a-b01d2feea372",
"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": "a8e80d24-5f24-4097-83ad-e17447396038",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ba169f31-39a3-4cf3-b0e2-26a6173d2be1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "82b5e893-a359-4109-af10-abcbfc872e3c",
"account_manager_user_code": "sample string 56",
"company_status_id": "f0e7e873-209a-42ff-ba62-6a58fb6230af",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-15T23:32:42.4176324+00:00",
"id2": 60
},
"db_language_id": "14358a18-8802-452d-b875-f65d3b34d8ed",
"db_language_code": "sample string 7",
"db_title_id": "62672ee9-8ea1-4c00-bd24-34f348367916",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-15T23:32:42.4176324+00:00",
"create_date": "2025-11-15T23:32:42.4176324+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": "2025-11-15T23:32:42.4176324+00:00"
}