Retrieves the 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": "c4a1dd6e-96b5-4961-825b-ea206a63e4f6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8b7f39aa-f0e5-46ef-a37a-085e089fcc93",
"company_code": "sample string 5",
"company": {
"id": "229d33ca-b4a3-47f6-914a-99ff71941621",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-02T19:31:21.8912435+00:00",
"sales_territory_id": "c6e752d0-27a4-4584-95ab-7140c51b2dd8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "629d8c32-f43b-4301-94a9-d1a4d2c68a6f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "431ac465-70c8-4670-8d3c-f9dcb035dfd9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "71fa24dd-2908-485e-a1f0-0110b349d6f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0ee4101-6c6d-441e-944a-b3da566b5845",
"db_currency_id": "67afb1bf-d75e-44cb-9d1d-8107bba14a08",
"db_language_id": "7b00d586-3ae9-413a-a3bc-290debef1b51",
"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-10-02T19:31:21.8912435+00:00"
},
"modified_dateutc": "2025-10-02T19:31:21.8912435+00:00"
},
"marketing_segment_id": "1c22863d-3c2d-44f0-891d-a3dae375564d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3602ab20-bbd7-4f03-ae82-ea8363b7d33b",
"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": "ef7a05d8-cfb9-45c5-b855-40cf77f14347",
"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": "a6bdab96-2774-4da0-a106-9dd11357ac76",
"db_country_code": "sample string 28",
"feelist_id": "359f1003-bbca-4630-85d1-65137c1d36ab",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "313f67e7-872d-448b-b181-2ed329d99b63",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "697aaaf4-ddff-424c-98c6-558ba21f6464",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-02T19:31:21.8912435+00:00",
"db_currency_id": "3a57eba3-ef50-4c49-a1dc-2f3171f81c7c",
"db_currency_code": "sample string 10"
},
"company_type_id": "fe69e32f-8c4d-4372-a422-ad38955fd785",
"company_type_name": "sample string 32",
"company_type": {
"id": "2f9224cf-7b09-46c6-99c1-3cbb1241da16",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "377e6006-6f72-447e-bf3c-4148cb1deb12",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e2912f67-c717-4df9-9bd0-caa8362e54eb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "10b1222d-8dde-4c94-96c4-839429e2c1bd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "95e192b7-4338-4991-81cc-833e36de2dd6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "43e52749-fcf6-42c8-b630-4f3f0064f8bc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-02T19:31:21.8912435+00:00"
},
"company_sector_id": "c99132ee-483c-4c71-ae42-d57ae3bdde34",
"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": "6e019f30-1b2c-4e2b-983b-918f28efbee0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "65dd3f3c-755c-4ceb-8455-d59c440dbfe6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c3cf7d29-11e5-4e5b-a534-3c9e17167bbf",
"account_manager_user_code": "sample string 56",
"company_status_id": "6c3f8c93-b0ce-41c7-9a6e-429ad719608f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-02T19:31:21.8912435+00:00",
"id2": 60
},
"db_language_id": "adf9c2b6-353b-42c8-b389-ecc4327e6d01",
"db_language_code": "sample string 7",
"db_title_id": "a76ad8f9-d841-4ee0-a26d-f6ead55dddbd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-02T19:31:21.8912435+00:00",
"create_date": "2025-10-02T19:31:21.8912435+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-10-02T19:31:21.8912435+00:00"
}