---
title: "List of call flows with route information belonging to the user group and all children with count"
method: GET
path: "/callflow/count"
tags: ["callflow"]
---

# List of call flows with route information belonging to the user group and all children with count

`GET /callflow/count`

Retrieves call flows with routing information along with total count metrics. Returns call flow configurations with routing details plus pagination metadata including total records. Supports filtering.

## Query parameters

- `limit` integer
- `offset` integer
- `filter` string[]

## Response `200`

Call flows with routing information plus total count and filtered count metrics. Note Multi-Level IVR and Outbound route types are only included when configured and available in the new UI.

- object
  - `total_count` integer — Total number of records matching the filter (across all pages). Integer. Returned by /callflow/count for pagination awareness.
  - `count` integer — Count of records returned in the current response. Integer.
  - `call_flow_list` CallflowRouteResponseWithCount[] — call_flow_list. Type: array of object (CallflowRouteResponseWithCount).
    - `call_flow_id` integer — Unique identifier for the call flow/route definition the call was answered by. Integer. Maps to call_flow.call_flow_id.
    - `call_flow_name` string, required — Human-readable name of the call flow/route. String.
    - `call_flow_created` string, date-time — The date and time that the call flow was created. Type: string (date-time).
    - `call_flow_status` 'active' | 'inactive' — call_flow_status. Type: enum (string); Allowed values: active, inactive.
    - `campaign_id` integer — Unique identifier for the campaign this call was attributed to. Integer.
    - `campaign_name` string — Human-readable campaign name. String.
    - `campaign_ext_id` string — Customer-provided external identifier for the campaign. Integer.
    - `repeat_interval` integer — The amount of minutes before the route can be used again. Type: integer (int32).
    - `call_value` integer — Monetary value assigned to the call by scoring/analytics. Integer (cents or whole dollars depending on account config).
    - `channel_id` integer, required — Unique identifier for the marketing channel tagged on this call. Integer. See /misc/channel for available channels.
    - `dnis` string — The unique ID assigned to an group for use with DNI. Type: string.
    - `message_enabled` boolean — Indicates whether the message feature is enabled or not. Type: boolean.
    - `message` string — SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).
    - `default_ringto` string — The default number to route to for a call flow should be 10 number. Type: string.
    - `group_id` integer, required — Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.
    - `email_to_notify` string — The e-mail address(es) to notify for call flow. Type: string.
    - `play_disclaimer` 'before' | 'after' | 'never' — Identifies whether to play the disclaimer message or not. Type: enum (string); Allowed values: before, after, never.
    - `created_at` string, date-time — The date and time at which the call flow was created. Type: string (date-time).
    - `updated_at` string, date-time — The date and time at which the call flow was last updated. Type: string (date-time).
    - `voicemail_greeting` string — The greeting to play if voicemail feature is enabled. Type: string.
    - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature. Type: boolean.
    - `voicemail_rings` integer — The unique identifier for the rings for Voicemail (1-10). Filter will not apply for voicemail_rings. Type: integer (int32).
    - `routable_id` integer — The routable_id is used to get route info. Type: integer (int32).
    - `routable_type` 'SimpleRoute' | 'IvrRoute2' | 'PercentageBasedRoute' | 'ScheduleRoute' | 'GeoRoute' | 'OutboundRoute' | 'HangupRoute', required — routable_type. Type: enum (string); Allowed values: SimpleRoute, IvrRoute2, PercentageBasedRoute, ScheduleRoute, GeoRoute, OutboundRoute, HangupRoute.
    - `webhook_enabled` boolean — Indicates whether or not a call flow uses webhooks. Type: boolean.
    - `record_until` string, date-time — The date and time to record until. Type: string (date-time).
    - `whisper_enabled` boolean — Indicates whether or not whisper messaging is enabled. Type: boolean.
    - `whisper_message` string — The message that should be played for the whisper or unique reference id. Type: string.
    - `ring_delay` integer — The number of seconds to delay before ringing. Type: integer (int32).
    - `postcall_ivr_enabled` boolean — Indicates whether call flow has post call routing actions enabled. Type: boolean.
    - `postcall_ivr_id` integer — The unique identifier for the post call action to take. Type: integer (int32).
    - `spam_threshold` integer — The threshold level of tolerance to allow on spam (0-5). Type: integer (int32).
    - `spam_filter_enabled` boolean — Determines whether or not spam filtering is enabled. Type: boolean.
    - `referral_number` string — The referral number to route to for a call flow if call flow is in referral state. Type: string.
    - `referral_end_date` string, date-time — The referral date to route to for a call flow if call flow is in referral state. Type: string (date-time).
    - `record_call_enabled` boolean — Enable/disable record call feature, play_disclaimer and record_until takes precedence. Type: boolean.
    - `geo_route` object — geo_route.
      - `play_branding` boolean — Indicates whether or not to play branding message. Type: boolean.
      - `radius` integer, required — Defines the radius in miles. Type: integer (int32).
      - `strategy` 'Claimed' | 'Npa' | 'Zipcode' — Indicates the method used for the geo route. Type: enum (string); Allowed values: Claimed, Npa, Zipcode.
      - `allow_manual_entry` boolean — Indicates whether or not to allow manual entry. Type: boolean.
      - `options` object[] — options. Type: array of object.
        - `geo_target_did` integer, required — The target phone number to be used. Type: integer (int32).
        - `latitude` number, float — The geospatial horizontal location of the route. Type: number (float).
        - `longitude` number, float — The geospatial vertical location of the route. Type: number (float).
        - `address` string — Caller's street address. String.
        - `city` string — Caller's city (from caller-ID/location lookup). String.
        - `geo_created_at` string, date-time — The date and time when the geo location was created. Type: string (date-time).
        - `geo_updated_at` string, date-time — The date and time the geo location was last updated. Type: string (date-time).
    - `outbound` object — outbound.
      - `set_caller_id` string — Caller Number set for outbound call. Type: string.
      - `pin` string — Authentication pin code. Type: string.
    - `ivr_route` object — ivr_route.
      - `repeat_greeting` boolean — Indicates whether or not to repeat the greeting. Type: boolean.
      - `options` object[] — options. Type: array of object.
        - `ivr_option_id` integer — Unique identifier. Type: integer (int32).
        - `value` integer — Specifies which number was pressed for this option. Type: integer (int32).
        - `ivr_target_did` integer — The target phone number to use for this option. Type: integer (int32).
        - `ivr_email_to_notify` string — The e-mail address(es) to notify for option. Type: string.
        - `ivr_play_disclaimer` boolean — Indicates whether or not to play the disclaimer for this option. Type: boolean.
        - `ivr_record_enabled` boolean — Indicates whether or not recording is enabled for this option. Type: boolean.
        - `ivr_voicemail_enabled` boolean — Indicates whether or not the voice mail feature is enabled for this option. Type: boolean.
        - `ivr_webhook_enabled` boolean — Indicates whether or not webhooks are enabled for this option. Type: boolean.
        - `ivr_message_enabled` boolean — Indicates whether or not a message is enabled for this option. Type: boolean.
        - `ivr_message` string — The message to play for this option if enabled. Type: string.
        - `ivr_whisper_enabled` boolean — Indicates whether or not whisper messaging is enabled for this option. Type: boolean.
        - `ivr_whisper_message` string — The whisper message to play if enabled. Type: string.
        - `ivr_created_at` string, date-time — The date and time when this IVR option was created. Type: string (date-time).
        - `ivr_updated_at` string, date-time — The date and time when this IVR option was last updated. Type: string (date-time).
    - `percentage_route` object[] — percentage_route. Type: array of object.
      - `percentage` integer — The whole number value of the percentage amount. Type: integer (int32).
      - `per_target_did` integer — The target phone number for this percentage route. Type: integer.
    - `schedule_route` object — schedule_route.
      - `timezone` integer — Timezone value as the number of hour from Greenwhich Mean Time. Type: integer (int32).
      - `options` object[] — options. Type: array of object.
        - `sch_target_did` integer — The target phone number for this schedule option. Type: integer (int32).
        - `day` integer — The number of days for the schedule option. Type: integer (int32).
        - `from_time` integer — The time as military hour and minute for the beginning of the schedule option. Type: integer (int32).
        - `to_time` integer — The time as military hour and minte for the end of the schedule option. Type: integer (int32).
        - `sch_created_at` string, date-time — The date and time when the schedule option was created. Type: string (date-time).
        - `sch_updated_at` string, date-time — The date and time when the schedule option was last updated. Type: string (date-time).
    - `hunt_type` string — This is uniquely identified the hunt type for a call flow. Type: string.
    - `overflowNumbers` OverflowNumbers[] — overflowNumbers. Type: array of object (overflowNumbers).
      - `overflowNumber` integer, required — The unique identifier for the overflowNumber. Type: integer (int32).
      - `rings` integer, required — The unique identifier for the rings for overflowNumber. Type: integer (int32).
    - `ivrs` object[], required — ivrs. Type: array of object.
      - `ivr_option_id` integer — Unique identifier. Type: integer (int32).
      - `key` integer, required — Enter the key to be pressed by the caller. Type: integer (int32).
      - `action` 'interactiveVoice' | 'simple' | 'schedule' | 'hangup' | 'geo', required — Set the action. Type: enum (string); Allowed values: interactiveVoice, simple, schedule, hangup, geo.
      - `destination` string, required — Enter the destination name for the key press. Type: string.
      - `message` string — SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).
      - `ivrData` IvrDataGet[] — ivrData. Type: array of object (ivrDataGet).
        - `ivr_option_id` integer — Unique identifier. Type: integer (int32).
        - `key` integer, required — Enter the key to be pressed by the caller. Type: integer (int32).
        - `action` 'interactiveVoice' | 'simple' | 'schedule' | 'hangup' | 'geo', required — Set the action. Type: enum (string); Allowed values: interactiveVoice, simple, schedule, hangup, geo.
        - `destination` string, required — Enter the destination name for the key press. Type: string.
        - `message` string — SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).
        - `ivrData` object[] — ivrData. Type: array of object.
          - `ivr_option_id` integer — Unique identifier. Type: integer (int32).
          - `key` integer, required — Enter the key to be pressed by the caller. Type: integer (int32).
          - `action` 'simple' | 'schedule' | 'hangup' | 'geo', required — Set the action. Type: enum (string); Allowed values: simple, schedule, hangup, geo.
          - `destination` string, required — Enter the destination name for the key press. Type: string.
          - `message` string — SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).
          - `geoData` GeoData
            - `route_by` 'Claimed State' | 'Claimed Zip-code' | 'Caller Area Code Proximity' | 'Zip-code Proximity', required — Indicates the method used for the geo route
            - `proximity_limit` number, float — Defines the radius in miles
            - `location_id` integer, required — The unique identifier of the location
            - `target_did` integer, required — Enter the target number for the IVR to geo route
          - `scheduleRoute` ScheduleData
            - `timezone` 'Atlantic' | 'Eastern' | 'Central' | 'Mountain' | 'Arizona' | 'Pacific', required — set timezone for the schedule route
            - `default_ringto` integer — Enter the default_ringto number for the schedule route
            - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature for default rinto number.
            - `schedules` object[], required
              - …
          - `target_did` integer — Enter the target number for the IVR route. Type: integer (int32).
          - `isSimultaneous` boolean — The isSimultaneous is used to create hunt type for a call flow and its mandatory when you are adding overflowNumbers in call flow. Type: boolean.
          - `overflowNumbers` OverflowNumbers[] — overflowNumbers. Type: array of object (overflowNumbers).
            - `overflowNumber` integer, required — The unique identifier for the overflowNumber. Type: integer (int32).
            - `rings` integer, required — The unique identifier for the rings for overflowNumber. Type: integer (int32).
          - `record_enabled` boolean — Set the call recording to on/off. Type: boolean.
          - `play_disclaimer` 'before' | 'after' | 'never' — Set the disclaimer to be played or not played. Type: enum (string); Allowed values: before, after, never.
          - `whisper_enabled` boolean — Indicates whether or not whisper messaging is enabled. Type: boolean.
          - `whisper_message` string — The message that should be played for the whisper or unique reference id. Type: string.
          - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature. Type: boolean.
          - `go_back_key` integer, required — Enter the key to be pressed by the caller to back to previous menu. Type: integer (int32).
        - `geoData` GeoData
          - `route_by` 'Claimed State' | 'Claimed Zip-code' | 'Caller Area Code Proximity' | 'Zip-code Proximity', required — Indicates the method used for the geo route
          - `proximity_limit` number, float — Defines the radius in miles
          - `location_id` integer, required — The unique identifier of the location
          - `target_did` integer, required — Enter the target number for the IVR to geo route
        - `scheduleRoute` ScheduleData
          - `timezone` 'Atlantic' | 'Eastern' | 'Central' | 'Mountain' | 'Arizona' | 'Pacific', required — set timezone for the schedule route
          - `default_ringto` integer — Enter the default_ringto number for the schedule route
          - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature for default rinto number.
          - `schedules` object[], required
            - `schedule_days` object[], required — Set the schedule days for the schedule route. Type: array of object.
              - …
            - `schedule_start_time` string, required — The time for the beginning of the schedule option. Type: string.
            - `schedule_end_time` string, required — The time for the end of the schedule option. Type: string.
            - `ring_to` integer, required — Phone number the call was ultimately forwarded to (the agent/business line). String of digits.
            - `overflowNumbers` OverflowNumbers[] — overflowNumbers. Type: array of object (overflowNumbers).
              - …
            - `isSimultaneous` boolean — The isSimultaneous is used to create hunt type for a call flow and its mandatory when you are adding overflowNumbers in call flow. Type: boolean.
            - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature for schdeule rinto number. Type: boolean.
        - `target_did` integer — Enter the target number for the IVR route. Type: integer (int32).
        - `isSimultaneous` boolean — The isSimultaneous is used to create hunt type for a call flow and its mandatory when you are adding overflowNumbers in call flow. Type: boolean.
        - `overflowNumbers` OverflowNumbers[] — overflowNumbers. Type: array of object (overflowNumbers).
          - `overflowNumber` integer, required — The unique identifier for the overflowNumber. Type: integer (int32).
          - `rings` integer, required — The unique identifier for the rings for overflowNumber. Type: integer (int32).
        - `record_enabled` boolean — Set the call recording to on/off. Type: boolean.
        - `play_disclaimer` 'before' | 'after' | 'never' — Set the disclaimer to be played or not played. Type: enum (string); Allowed values: before, after, never.
        - `whisper_enabled` boolean — Indicates whether or not whisper messaging is enabled. Type: boolean.
        - `whisper_message` string — The message that should be played for the whisper or unique reference id. Type: string.
        - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature. Type: boolean.
        - `go_back_key` integer, required — Enter the key to be pressed by the caller to back to previous menu. Type: integer (int32).
      - `geoData` GeoData
        - `route_by` 'Claimed State' | 'Claimed Zip-code' | 'Caller Area Code Proximity' | 'Zip-code Proximity', required — Indicates the method used for the geo route
        - `proximity_limit` number, float — Defines the radius in miles
        - `location_id` integer, required — The unique identifier of the location
        - `target_did` integer, required — Enter the target number for the IVR to geo route
      - `scheduleRoute` ScheduleData
        - `timezone` 'Atlantic' | 'Eastern' | 'Central' | 'Mountain' | 'Arizona' | 'Pacific', required — set timezone for the schedule route
        - `default_ringto` integer — Enter the default_ringto number for the schedule route
        - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature for default rinto number.
        - `schedules` object[], required
          - `schedule_days` object[], required — Set the schedule days for the schedule route. Type: array of object.
            - `id` 'AllDays' | 'Mon-Fri' | 'Sat-Sun' | 'Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun', required
          - `schedule_start_time` string, required — The time for the beginning of the schedule option. Type: string.
          - `schedule_end_time` string, required — The time for the end of the schedule option. Type: string.
          - `ring_to` integer, required — Phone number the call was ultimately forwarded to (the agent/business line). String of digits.
          - `overflowNumbers` OverflowNumbers[] — overflowNumbers. Type: array of object (overflowNumbers).
            - `overflowNumber` integer, required — The unique identifier for the overflowNumber. Type: integer (int32).
            - `rings` integer, required — The unique identifier for the rings for overflowNumber. Type: integer (int32).
          - `isSimultaneous` boolean — The isSimultaneous is used to create hunt type for a call flow and its mandatory when you are adding overflowNumbers in call flow. Type: boolean.
          - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature for schdeule rinto number. Type: boolean.
      - `target_did` string — Enter the target number for the IVR route. Type: string.
      - `isSimultaneous` boolean — The isSimultaneous is used to create hunt type for a call flow and its mandatory when you are adding overflowNumbers in call flow. Type: boolean.
      - `overflowNumbers` OverflowNumbers[] — overflowNumbers. Type: array of object (overflowNumbers).
        - `overflowNumber` integer, required — The unique identifier for the overflowNumber. Type: integer (int32).
        - `rings` integer, required — The unique identifier for the rings for overflowNumber. Type: integer (int32).
      - `record_enabled` boolean — Set the call recording to on/off. Type: boolean.
      - `play_disclaimer` 'before' | 'after' | 'never' — Set the disclaimer to be played or not played. Type: enum (string); Allowed values: before, after, never.
      - `whisper_enabled` boolean — Indicates whether or not whisper messaging is enabled. Type: boolean.
      - `whisper_message` string — The message that should be played for the whisper or unique reference id. Type: string.
      - `voicemail_enabled` boolean — Indicates whether or not to use the voice mail feature. Type: boolean.

## Other responses

- `default` — Unexpected error

---

[API](https://skmtc.net/convirza/apis/convirza-apis.md) · [All operations](https://skmtc.net/convirza/apis/convirza-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/convirza/convirza-apis/versions/ccf9bbe34f5a/schema)