Retrieves the contact with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

contact
NameDescriptionTypeAdditional 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

email

email

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": "6e2fc167-3660-4dc7-9ccc-d0567ce8bdea",
  "firstname": "sample string 2",
  "lastname": "sample string 3",
  "company_id": "6fc9e2e6-06ed-41c8-ac11-f8219a9c4749",
  "company_code": "sample string 5",
  "company": {
    "id": "757abae2-7ca7-4d9f-9434-bb6dfdc717a8",
    "is_client": true,
    "is_supplier": true,
    "archived": true,
    "name": "sample string 5",
    "notes": "sample string 6",
    "create_date": "2024-03-26T17:40:10.2219279+00:00",
    "sales_territory_id": "e5897fdf-3252-4361-827c-1bdb3e539ebb",
    "sales_territory_code": "sample string 9",
    "sales_territory": {
      "id": "c095e922-eb92-4807-b9a2-362ad1ff4eb5",
      "code": "sample string 2",
      "description": "sample string 3",
      "sales_organization_id": "93f40a9b-76ad-4726-b8cc-925741958b11",
      "sales_organization_code": "sample string 5",
      "sales_organization": {
        "id": "ad64b53f-8f1c-4abb-bfb9-3dcecfcac8ae",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2e667550-828b-4913-bb1a-cc13fb99096c",
        "db_currency_id": "9ff1c734-8df4-4096-856e-aeab1ef2ddf1",
        "db_language_id": "e36210cb-b477-49a0-992b-ac50fef66bd8",
        "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": "2024-03-26T17:40:10.2219279+00:00"
      },
      "modified_dateutc": "2024-03-26T17:40:10.2219279+00:00"
    },
    "marketing_segment_id": "51c4e778-3136-4b32-a6be-d3b144ae4626",
    "marketing_segment_code": "sample string 11",
    "sales_organization_id": "75572c63-44cd-4f1b-8b9f-78865eb46376",
    "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": "2f4631b5-059a-45bb-93bb-c10e4d1da7e2",
    "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": "8fc77e1f-3e7e-46c3-8729-fec3095c9d35",
    "db_country_code": "sample string 28",
    "feelist_id": "51f17319-b8b0-4442-9b58-b76e3abcd373",
    "feelist_reference_back_office": "sample string 30",
    "feelist": {
      "id": "bb83490d-154a-4221-b398-cfcd6876e58b",
      "name": "sample string 2",
      "description": "sample string 3",
      "is_default": true,
      "default_price": 1.0,
      "sales_organization_id": "489d0172-a23c-464f-84ce-caa0ca470581",
      "sales_organization_code": "sample string 6",
      "reference_back_office": "sample string 7",
      "modified_dateutc": "2024-03-26T17:40:10.2219279+00:00",
      "db_currency_id": "7a63339f-5c5b-4c2f-be6e-c702779028b2",
      "db_currency_code": "sample string 10"
    },
    "company_type_id": "e1835232-6132-48f5-97b9-faff8f4f6429",
    "company_type_name": "sample string 32",
    "company_type": {
      "id": "de33725c-2ef7-4a96-ac91-564dce2bc47a",
      "name": "sample string 2",
      "description": "sample string 3",
      "sales_organization_id": "46d8febc-c74e-4274-b81e-64f2c30e202f",
      "sales_organization_code": "sample string 5"
    },
    "db_language_id": "309c88d9-378b-4ea2-b159-d4a102f4898e",
    "db_language_code": "sample string 34",
    "code": "sample string 35",
    "article_price_label_id": "0e21104a-50f3-4d0b-a5e1-d27572e0d5a1",
    "article_price_label_code": "sample string 37",
    "db_payment_method_id": "85cee447-52d7-44e2-ab79-bff466f2f0a2",
    "db_payment_method_reference_back_office": "sample string 39",
    "db_payment_methods": {
      "id": "2819ea47-6f02-4ba4-8a4e-754b410a03cf",
      "name": "sample string 2",
      "description": "sample string 3",
      "reference_back_office": "sample string 4",
      "activated": true,
      "modified_dateutc": "2024-03-26T17:40:10.2219279+00:00"
    },
    "company_sector_id": "f586f579-3566-4a8f-baaf-acbc8ac85dc6",
    "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": "6c0b07df-869b-403f-a299-eef29835037a",
    "service_manager_user_code": "sample string 52",
    "finance_manager_user_id": "783e57d4-7227-42fa-950f-c6c851dd9935",
    "finance_manager_user_code": "sample string 54",
    "account_manager_user_id": "1536a0c1-461c-41ef-878f-da63a97eefbd",
    "account_manager_user_code": "sample string 56",
    "company_status_id": "6645c2b0-62cb-4bd8-8db5-fe05858412da",
    "invoice_email_to": "sample string 58",
    "modified_dateutc": "2024-03-26T17:40:10.2219279+00:00",
    "id2": 60
  },
  "db_language_id": "08ada7eb-8fcd-4a7a-9469-d1bcf043ef1c",
  "db_language_code": "sample string 7",
  "db_title_id": "46a24825-121d-479b-a317-cfc1c7d8099f",
  "archived": true,
  "functions": "sample string 10",
  "e_login": "sample string 11",
  "e_password": "sample string 12",
  "notes": "sample string 13",
  "birthdate": "2024-03-26T17:40:10.2219279+00:00",
  "create_date": "2024-03-26T17:40:10.2219279+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": "2024-03-26T17:40:10.2219279+00:00"
}