Retrieve feeds — list, count, or list-latest (unified endpoint)

GET /task/v1/feeds/{retrieve-type}

Operation id: retrieveFeedsByType

Description

Unified endpoint for three feed retrieval modes controlled by retrieve-type path variable.

Session-derived values (domain_id, user_id, unit_id, dept_id, profile_id, time_zone_long, lang_code) are always resolved from the auth token and cannot be overridden by query parameters. Query params are auto-converted from snake_case to camelCase. All response keys are returned in snake_case.

Retrieve Types

Parameter Applicability Matrix

Legend: ✅ = accepted/used | REQ = required | — = not applicable (silently ignored)

Cursor-Based Pagination (list only)

1. Initial request: No cursor params — GET /task/v1/feeds/list?status=N&limit=20
2. Response includes: has_more, next_cursor (base64 opaque), previous_cursor, last_fetch_time
3. Next page (forward): ?...&starting_after=<next_cursor value>
4. Previous page (backward): ?...&ending_before=<previous_cursor value>

Rules:

• Use only one of starting_after or ending_before per request — providing both → E112
• Cursors are opaque strings — do not parse or construct them manually
• limit is clamped to 1–100: values below 1 default to 20, values above 100 cap at 100
• has_more: false means no further pages in the requested direction

Projections — Default Fields

When projections is omitted, the following 35 fields are returned for each feed object. feed_key is always included regardless of what is requested.

feed_key, feed_title, message_type, status, priority, feed_type, feed_type_id, cluster_id, cluster_child_id, start_date_time, end_date_time, display_launch_date, create_dtm, last_updated_time, task_count, overdue_task_count, pin, favorite_flag, acknowledged_flag, is_confidential, has_survey, title_css, panel_config, assign_to_desc, has_comments, enable_comment, future_feed, show_why_url, has_action, enable_action, show_how_url, has_history, has_user_notes, has_actions, has_contents, has_key_attributes

Projections — Additional Available Fields

These fields are not in the default set but can be explicitly requested:

transaction_key, feed_owner, feed_type_id_desc, ext_link_info, dept_id, end_date_utc, display_start_date, last_action_time_in_millis, profile_id, display_date, has_predecessor, show_acknowledge, last_updated_time_in_millis, event_date, additional_attributes, show_claim, promote_to_note_flag, update_all_mul_asg_task_attr, flag, is_edited, allow_future_quick_links, thread_flag, acknowledge_flag, txn_dtm, lock_status, start_date_utc, unit_id, last_action_time, action_taken_flag, time_to_act, feed_description, feed_params, event_end_date, watch_flag, follow, user_id, feed_task_count, display_end_date

Note: filter_id overrides the standard query path — when provided, the system uses the MwFilterConfig for data retrieval instead of applying the filter params above.

Error Scenarios

Error Codes Reference

Tags: MyWorkFeeds

Parameters

Path parameters

Query parameters

Security

• AuthTokenHeader (apiKey)
  • Session authentication token validated server-side against the user session store.

Responses

200 — list → {feed_details[], previous_cursor, next_cursor, has_more, last_fetch_time} — or E404 no data.

count → {count_data: {priorities[], total}}. list-latest → {feed_list_latest[], status}.

Content type: application/json

400 — - E111 — invalid retrieve-type

• E112 — both starting_after and ending_before provided
• E114 — missing start_date for count
• E115 — missing end_date for count
• E116 — refresh interval exceeded for list-latest

Content type: application/json

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Response models

200 — list → {feed_details[], previous_cursor, next_cursor, has_more, last_fetch_time} — or E404 no data.

count → {count_data: {priorities[], total}}. list-latest → {feed_list_latest[], status}.

Content type: application/json

Schema

JSON object (structure varies by endpoint).

{
  "type": "object",
  "description": "JSON object (structure varies by endpoint)."
}

Example:

{
  "status": "OK",
  "feed_details": [],
  "previous_cursor": null,
  "next_cursor": "eyJza2lwIjoyMH0=",
  "has_more": true,
  "last_fetch_time": 1774373200310
}

400 — - E111 — invalid retrieve-type

• E112 — both starting_after and ending_before provided
• E114 — missing start_date for count
• E115 — missing end_date for count
• E116 — refresh interval exceeded for list-latest

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E202",
  "response": "User session is invalid"
}

500 — Unexpected server-side error

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E302",
  "response": "Internal server error"
}