Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Restricting Workitem Filters to Three for Workitem Sync Query (Preview API)

  • 1.  Restricting Workitem Filters to Three for Workitem Sync Query (Preview API)

    Posted 9 hours ago

    Summary

    The Workitem Sync Query Preview API will now enforce a limit of three filters per request.

    Of these three filters, one must be a single equals (EQ) filter on one of the following attributes:

    • queueId

    • typeId

    • assigneeId

    • workbinId

    Effective Date

    Monday, March 2, 2026

    Details

    Previous behavior:

    Users could provide more than three filters, for example:

    "filters": [
  {
    "name": "assigneeId",
    "type": "string",
    "operator": "EQ",
    "values": ["461a72d1-0c82-4732-a880-5b18b9f999da"]
  },
  {
    "name": "name",
    "type": "string",
    "operator": "EQ",
    "values": ["Test Workitem"]
  },
  {
    "name": "description",
    "type": "string",
    "operator": "EQ",
    "values": ["Test Workitem"]
  },
  {
    "name": "assignmentState",
    "type": "string",
    "operator": "EQ",
    "values": ["Connected"]
  }
]

    New behavior:

    Requests are limited to three filters, with one required to be a single EQ filter on one of the supported attributes:

    "filters": [
  {
    "name": "assigneeId",
    "type": "string",
    "operator": "EQ",
    "values": ["461a72d1-0c82-4732-a880-5b18b9f999da"]
  },
  {
    "name": "name",
    "type": "string",
    "operator": "EQ",
    "values": ["Test Workitem"]
  },
  {
    "name": "description",
    "type": "string",
    "operator": "EQ",
    "values": ["Test Workitem"]
  }
]

    This API is intended for operational lookups. Restricting the number of filters improves predictability and consistency of the user experience. For broader or more complex searching, the Workitems Job Query API should be used instead.

    Customer Impact

    Any request that includes more than three filterswill result in a 400 Bad Requestresponse.

    Impacted Resources

    (Preview) POST /api/v2/taskmanagement/workitems/query

    Issue References

    WORKITEMS-6136

    Contacts

    @Caoimhe Rice  

    Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.



Related Content