Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

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

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

    Posted 16 hours ago

    Summary

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

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

    • queueId

    • typeId

    • assigneeId

    • workbinId

    Previous behavior:

    Users could include any number of filters, including multiple non-indexed attributes, 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"]
  }
]

    New behavior:

    Only two filters are allowed, and one must be a single EQ filteron queueId, typeId, assigneeId, or workbinId:

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

    Effective Date

    Monday, December 22, 2025

    Details

    Allowing more than two filters increases the likelihood of receiving empty pages in the paginated response. Restricting filters reduces this risk and improves consistency and performance of the workitem synchronization process.

    Customer Impact

    Any Workitem Sync Query request that includes more than two filters will result in a 400 Bad Requesterror.

    Impacted Resources

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

    Issue References

    [WORKITEMS-6136]

    Contacts

    @Edel Kelly  @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