Returns a list of all SelfServiceMembershipStep

GET /api/cp/self_service_membership/step

Query parameters

  • id string

    Requires access right: SCOPE

  • deleted boolean

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

  • order integer

    Requires access right: SCOPE

  • name string

    Requires access right: SCOPE

  • 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 all SelfServiceMembershipStep

    Hide response attributes Show response attributes object
    • id integer
    • item_selection_required boolean
    • multi_selection_allowed boolean
    • only_if_no_memberships boolean
    • categories array[object]
      Hide categories attributes Show categories attributes object
      • name string
      • deleted boolean
      • image_url string
      • order integer
    • name string
    • deleted boolean
    • image_url string
    • order integer
GET /api/cp/self_service_membership/step
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/cp/self_service_membership/step' \
 --header "x-session-token: $API_KEY"
Response examples (200)
[
  {
    "id": 42,
    "item_selection_required": true,
    "multi_selection_allowed": true,
    "only_if_no_memberships": true,
    "categories": [
      {
        "name": "string",
        "deleted": true,
        "image_url": "string",
        "order": 42
      }
    ],
    "name": "string",
    "deleted": true,
    "image_url": "string",
    "order": 42
  }
]