Returns a list of unified categories

GET /api/crm/category/unified

Query parameters

  • id string

    Requires access right: PUBLIC, PUBLIC_LIST, SCOPE

  • name string

    Requires access right: PUBLIC, PUBLIC_LIST, SCOPE

  • parent string

    Requires access right: PUBLIC, PUBLIC_LIST, SCOPE

  • categoryType string

    Requires access right: PUBLIC, PUBLIC_LIST, SCOPE

  • slugIdentifier string

    Requires access right: PUBLIC, PUBLIC_LIST, SCOPE

  • viewOrder integer

    Requires access right: PUBLIC, PUBLIC_LIST, SCOPE

  • isUiFilter string

    This property is used to mark an entity as a filter for the frontend | Requires access right: PUBLIC, PUBLIC_LIST, SCOPE

  • deleted boolean

    This property is used to mark an entity as deleted / archived | Requires access right: SCOPE | Default value: false

  • searchString string

    text to search for in the list

  • orderFieldName string

    name of the order field

  • orderFieldSort string

    sorting mode

    Values are DESC or ASC.

  • page integer

    page of the list

    Default value is 0.

  • pageSize integer

    number of entries for each page

    Minimum value is 1, maximum value is 200. Default value is 50.

  • withMaxPageNumber string

    returns the number of pages available as a header if this is set

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

Responses

  • 200 application/json

    Returns a list of unified categories

    Hide response attributes Show response attributes object
    • id integer
    • category_type string
    • children array[object]
    • parent object
    • view_order integer
    • is_public boolean
    • created string(date-time)
    • updated string(date-time)
    • name string
    • address string
    • address_street string
    • address_house_number string
    • address_street_level string
    • address_co string
    • address_city string
    • address_zip string
    • address_admin_level1 string
    • address_country string
    • address_full_country string
    • address_geo_lat string
    • address_geo_lng string
    • address_external_provider_id string
    • main_phone string
    • main_fax string
    • main_email string
    • website string
    • deleted boolean
    • search_string string
    • short_identifier string
    • slug_identifier string
    • image_url string
    • is_ui_filter boolean
GET /api/crm/category/unified
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/crm/category/unified' \
 --header "x-session-token: $API_KEY"
Response examples (200)
[
  {
    "id": 42,
    "category_type": "string",
    "children": [
      {}
    ],
    "parent": {},
    "view_order": 42,
    "is_public": true,
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z",
    "name": "string",
    "address": "string",
    "address_street": "string",
    "address_house_number": "string",
    "address_street_level": "string",
    "address_co": "string",
    "address_city": "string",
    "address_zip": "string",
    "address_admin_level1": "string",
    "address_country": "string",
    "address_full_country": "string",
    "address_geo_lat": "string",
    "address_geo_lng": "string",
    "address_external_provider_id": "string",
    "main_phone": "string",
    "main_fax": "string",
    "main_email": "string",
    "website": "string",
    "deleted": true,
    "search_string": "string",
    "short_identifier": "string",
    "slug_identifier": "string",
    "image_url": "string",
    "is_ui_filter": true
  }
]