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": "5ec109b7-e1c8-4c65-b43d-39afe4ddb939",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "75405300-70ff-4bc7-9674-ed61b87f425f",
"company_code": "sample string 5",
"company": {
"id": "69d97eb7-216e-4232-95d3-e6515c702279",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-15T03:02:14.607681+00:00",
"sales_territory_id": "80436a67-2dc6-4071-94bb-cab2a44ae530",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fc4b65dd-6064-4406-ab42-bcebdfa180da",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b4c1317b-28af-4a05-bc84-fdad8ce440f6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d334f8dd-a95b-4d90-a555-3854e48c4599",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f332bc3f-7876-4fc9-83fb-0840e090da66",
"db_currency_id": "1fddfa79-7745-4724-a4da-dd30f4108a1f",
"db_language_id": "aa1b780b-476d-49d2-b098-21a731ffef08",
"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-07-15T03:02:14.607681+00:00"
},
"modified_dateutc": "2026-07-15T03:02:14.607681+00:00"
},
"marketing_segment_id": "1774ac4e-29f9-4b07-bb6a-bddc69230c7f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "91d51f9a-5928-4151-afab-7ddb0891e45c",
"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": "040c09b3-4a5c-4160-a524-c2dc3ed3011a",
"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": "56643d1f-7de8-4918-b4bf-112aac193047",
"db_country_code": "sample string 28",
"feelist_id": "94d72e70-0026-4f2f-9f67-a95239b6400a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6ec1c4e6-5c9f-43c4-94f8-076305bb83b3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "43569112-c115-4a2b-b817-38f606c28351",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-15T03:02:14.607681+00:00",
"db_currency_id": "f4e4dcf4-a483-4c47-bd9c-f7c9dccb1268",
"db_currency_code": "sample string 10"
},
"company_type_id": "f0b54c7c-4c55-4b07-8b26-930d5fbe203f",
"company_type_name": "sample string 32",
"company_type": {
"id": "33bbf253-8d7f-41ca-8c73-d8b722814a62",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d40a5b94-670d-4ea7-bd6f-587d72de8088",
"sales_organization_code": "sample string 5"
},
"db_language_id": "50ce89b5-63df-4eeb-a836-30fb3d2e1147",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b57f8004-3259-450d-bc41-ad22996059d6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "901cad6e-5750-413e-bfb5-25baa63f2594",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "69dfd48e-59b2-4189-9920-48a90006608b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-15T03:02:14.607681+00:00"
},
"company_sector_id": "0c318666-9f28-4e5e-bb02-bb62a00ba1ac",
"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": "67dab90f-e352-4f6f-b02b-decbde7fca4a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "09f424fc-3ac2-43af-b72d-338d66dfe8a1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f3550d48-583f-4d4f-8e8e-e685082fe512",
"account_manager_user_code": "sample string 56",
"company_status_id": "74301807-b3ab-44bb-a396-242f6ea070db",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-15T03:02:14.607681+00:00",
"id2": 60
},
"db_language_id": "f8c3833b-c602-4344-ac38-2a6e9dda3731",
"db_language_code": "sample string 7",
"db_title_id": "c57c1165-69ad-44fe-aca6-3c3732374b58",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-15T03:02:14.607681+00:00",
"create_date": "2026-07-15T03:02:14.607681+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-07-15T03:02:14.607681+00:00"
}