Query parameters

• 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 SubscriptionItem

  Hide response attributes Show response attributes object

  • id integer
  • crm_person object
    Hide crm_person attributes Show crm_person attributes object

    • id integer
    • first_name string
    • last_name string
    • number integer
    • manual_number integer
    • number_string string
    • gender string
    • title string
    • position string
    • language string
    • special_salutation string
    • form_of_salutation string
    • birthday string(date-time)
    • known_allergies string
    • confirmed_no_allergies boolean
    • allow_photos boolean
    • allow_leaving_alone boolean
    • authorized_pickup string
    • needs_support boolean
    • support_description string
    • financial_support boolean
    • financial_support_number string
    • municipal_support boolean
    • municipal_support_number string
    • grade_level integer
    • school_class string
    • start_time string(date-time)
    • start_time_reason string
    • end_time string(date-time)
    • end_time_reason string
    • confirmed_gtc_time string(date-time)
    • crm_person_contact_data array[object]
      Hide crm_person_contact_data attributes Show crm_person_contact_data attributes object

      • id integer
      • name string
      • value string
      • generated_value string
      • contact_data_type object
        Hide contact_data_type attributes Show contact_data_type attributes object

        • id integer
        • name string
        • value string
        • allow_self_service boolean
        • deleted boolean
      • search_string string
    • archived boolean
    • subscribed_newsletter boolean
    • subscribed_magazine boolean
    • printed_member_card boolean
    • has_login_user boolean
    • profile_picture_url string
    • log_book_staff boolean
    • log_book_staff1 boolean
    • log_book_staff2 boolean
    • log_book_member boolean
    • log_book_trainer boolean
    • log_book_trainer1 boolean
    • log_book_trainer2 boolean
    • log_book_head_of_department boolean
    • log_book_supervisory_board boolean
    • log_book_board_of_directors boolean
    • log_book_honorary_member boolean
    • log_book_club_card_one boolean
    • log_book_health_recovered boolean
    • log_book_health_vaccinated boolean
    • log_book_health_vaccinated_addition string
    • sync_lanista boolean
    • category object
      Hide category attributes Show category attributes object

      • id integer
      • name string
      • name_plural string
      • description string
      • deleted boolean
      • is_public boolean
      • enabled_customer_create_new boolean
      • customer_register_min_number integer
      • customer_add_ignore_invite_code boolean
      • customer_ui_allowed_ticket_types string
      • enabled_customer_ui_selection boolean
      • order integer
    • nickname string
    • preferred_color_hex string
    • avatar_token string
    • search_string 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
    • created string(date-time)
    • updated string(date-time)
    • order integer
  • crm_company object
    Hide crm_company attributes Show crm_company attributes object

    • id integer
    • short_name string
    • company_name string
    • secondary_name string
    • direct_dial string
    • invoice_email string
    • send_invoice_email boolean
    • send_invoice_letter boolean
    • time_report_email string
    • payment_goal object
      Hide payment_goal attributes Show payment_goal attributes object

      • id integer
      • name string
      • date_string string
      • deleted boolean
      • global_default boolean
    • payment_interval string
    • vatid string
    • taxnumber string
    • buyer_reference_id string
    • tax object
      Hide tax attributes Show tax attributes object

      • id integer
      • name string Required
      • value number(float)

        Minimum value is 0, maximum value is 1.

      • deleted boolean
      • global_default boolean
    • info string
    • number string
    • manual_number integer
    • number_string string
    • is_customer boolean
    • is_supplier boolean
    • is_other boolean
    • is_member boolean
    • archived boolean
    • category object
      Hide category attributes Show category attributes object

      • id integer
      • name string
      • description string
      • deleted boolean
      • global_default boolean
      • enabled_customer_portal boolean
      • g_drive_root_dir string
      • g_drive_root_dir_archived string
      • require_company_address boolean
      • require_company_billing boolean
    • visible_for_customer boolean
    • search_string 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
    • created string(date-time)
    • updated string(date-time)
    • payment_type object
      Hide payment_type attributes Show payment_type attributes object

      • id integer
      • name string
      • auto boolean
      • conditions string
      • linked_keywords string
      • global_default boolean
      • bank_import_default boolean
      • is_direct_debit boolean
      • is_external boolean
      • deleted boolean
  • product object
    Hide product attributes Show product attributes object

    • id integer
    • name string Required
    • description string Required
    • internal_description string
    • fixed_hours number(float)
    • fixed_price number(float)
    • fixed_price_base_unit number(float)
    • price_fixed_hours number(float)
    • price_additional_hours number(float)
    • name_additional_hours string
    • description_additional_hours string
    • time_billed_on_ticket_close boolean
    • billing_type object
      Hide billing_type attributes Show billing_type attributes object

      • id integer
      • name string
      • fixed_price_addon_one_name string
      • fixed_price_addon_two_name string
      • fixed_price_addon_one_name_person string
      • fixed_price_addon_two_name_person string
      • category string Required

        Values are project, subscription, bookable, event, or shipping.

      • type string Required

        Values are subscription, bookable-hour, event-fixed, sla, hours, days, fixed, or internal.

      • unit string
      • force_repeating boolean
      • can_repeat boolean
      • deleted boolean
    • buying_price number(float)
    • recurrence object
      Hide recurrence attributes Show recurrence attributes object

      • id integer
      • name string
      • once boolean
      • allow_partial_on_eq_start_billing boolean
      • date_string string
      • tolerance number(float)
      • deleted boolean
      • rounding_steps integer
      • month_factor integer
    • deleted boolean
    • condition_date_after string(date-time)
    • condition_date_before string(date-time)
    • condition_country_code string
    • condition_zip_code_from string
    • condition_zip_code_to string
    • condition_time_after_hour integer
    • condition_max_length integer
    • condition_time_before_hour integer
    • condition_sub_access_tag object
      Hide condition_sub_access_tag attributes Show condition_sub_access_tag attributes object

      • id integer
      • created string(date-time)
      • updated string(date-time)
      • name string
      • deleted boolean
      • short_identifier string
    • condition_show_despite_missing_access_tag boolean
    • condition_sub_free_logic string
    • fixed_price_logic string
    • sub_self_service_add boolean
    • sub_self_service_delete boolean
    • sub_self_service_add_fixed_price number(float)
    • sub_self_service_delete_fixed_price number(float)
    • sub_pre_paid boolean
    • sub_only_billed_after_start boolean
    • sub_people_age_group_one integer
    • sub_people_age_group_one_discount integer
    • sub_people_age_group_one_free integer
    • sub_people_age_group_two integer
    • sub_people_age_group_two_discount integer
    • sub_people_age_group_two_free integer
    • sub_people_age_group_three integer
    • sub_people_age_group_three_discount integer
    • sub_people_age_group_three_free integer
    • sub_people_age_group_four integer
    • sub_people_age_group_four_discount integer
    • sub_people_age_group_four_free integer
    • price_is_brutto boolean
    • sku string
    • barcode string
    • company object
      Hide company attributes Show company attributes object

      • id integer
      • short_name string
      • company_name string
      • secondary_name string
      • direct_dial string
      • invoice_email string
      • send_invoice_email boolean
      • send_invoice_letter boolean
      • time_report_email string
      • payment_goal object
        Hide payment_goal attributes Show payment_goal attributes object

        • id integer
        • name string
        • date_string string
        • deleted boolean
        • global_default boolean
      • payment_interval string
      • vatid string
      • taxnumber string
      • buyer_reference_id string
      • tax object
        Hide tax attributes Show tax attributes object

        • id integer
        • name string Required
        • value number(float)

          Minimum value is 0, maximum value is 1.

        • deleted boolean
        • global_default boolean
      • info string
      • number string
      • manual_number integer
      • number_string string
      • is_customer boolean
      • is_supplier boolean
      • is_other boolean
      • is_member boolean
      • archived boolean
      • category object
        Hide category attributes Show category attributes object

        • id integer
        • name string
        • description string
        • deleted boolean
        • global_default boolean
        • enabled_customer_portal boolean
        • g_drive_root_dir string
        • g_drive_root_dir_archived string
        • require_company_address boolean
        • require_company_billing boolean
      • visible_for_customer boolean
      • search_string 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
      • created string(date-time)
      • updated string(date-time)
      • payment_type object
        Hide payment_type attributes Show payment_type attributes object

        • id integer
        • name string
        • auto boolean
        • conditions string
        • linked_keywords string
        • global_default boolean
        • bank_import_default boolean
        • is_direct_debit boolean
        • is_external boolean
        • deleted boolean
    • parent object
    • is_preferred boolean
    • is_default boolean
    • is_discount boolean
    • is_free boolean
    • is_passive boolean
    • is_global boolean
    • inventory_count integer
    • stock_item boolean
    • public_category string
    • search_string string
    • short_identifier string
    • slug_identifier string
    • order integer
  • start string(date-time)
  • end string(date-time)
  • billed string(date-time)
  • quantity number(float)
  • from_log_book_entry boolean
  • is_temporary boolean
  • from_ticket boolean
  • payment_type object
    Hide payment_type attributes Show payment_type attributes object

    • id integer
    • name string
    • auto boolean
    • conditions string
    • linked_keywords string
    • global_default boolean
    • bank_import_default boolean
    • is_direct_debit boolean
    • is_external boolean
    • deleted boolean
  • created string(date-time)
  • updated string(date-time)