Retrieves the type with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

marketing_segment
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
code

string

Max length: 50
segment

Marketing segment Name

 string

Required

Max length: 50
description

Description of the segment

 string

Max length: 255
visit_frequency_days_interval

Number of days between 2 visits

 integer
frequency_logic

Logic to apply for the frequency, which last events (value can be ORDER,MEETING_COMPLETED or ORDER_OR_MEETING_COMPLETED )

 string
sales_organization_id

FK of sales_organization. Filled if specific of one SO, empty if can be used by all

 globally unique identifier
sales_organization_code

Embedded entity "sales_organization" using ERP PK when adding/updating company_type

 string
sales_organization

Embedded entity "sales_organization" when adding/updating company_type

 sales_organization
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "9ae96e84-3221-426c-bf5f-00b560d1b610",
  "code": "sample string 2",
  "segment": "sample string 3",
  "description": "sample string 4",
  "visit_frequency_days_interval": 5,
  "frequency_logic": "sample string 6",
  "sales_organization_id": "51c3b3f3-e115-45a7-bd89-cc02eb2adc5e",
  "sales_organization_code": "sample string 8",
  "sales_organization": {
    "id": "bda72bfb-70bd-4736-99e5-3a03971d165b",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "3de165a8-eb36-41b5-b9d7-0e1ecb5935fe",
    "db_currency_id": "f7601a9f-a216-42c2-a0c6-ecbf102a9f83",
    "db_language_id": "37a8311d-0d89-46f5-a526-48e75c7c9333",
    "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-01-13T22:09:58.9095424+00:00"
  },
  "modified_dateutc": "2026-01-13T22:09:58.9095424+00:00"
}