Search

Find backlog items

get/api/search/backlog_items

Request

  • Base URL: https://api.atono.io
  • URL: https://api.atono.io/api/search/backlog_items
  • Auth: API key in header X-API-KEY

Query parameters

keywordSearchstring nullable
assigneeIdsstring nullable
createdAtstring nullable
cycleTimeMode'NORMAL' | 'OUTLIER'
doneAtstring nullable
environmentIdsstring nullable
epicIdsstring nullable
excludeLinkedItemIdstring uuid nullable
excludeTagIdsstring nullable
excludeTagValueIdsstring nullable
externalIdstring nullable
handlestring nullable
productThemeIdsstring nullable
riskRatingstring nullable
sizeIdsstring nullable
stepIdsstring nullable
tagIdsstring nullable
tagValueIdsstring nullable
teamIdsstring nullable
timeboxIdsstring nullable
triageGroup'TRIAGE' | 'NOT_TRIAGED' | 'INFO_REQUIRED' | 'REJECTED'
typestring nullable
updatedAtstring nullable

Filter for backlog items. Notes about specific filter parameters

  • filter[handle]: if specified, filter by handle is applied first to perform a lookup by handle.
  • filter[assigneeIds]: pipe-separated list of UUIDs, can include 'NONE'
  • filter[keywordSearch]: Find backlog items that match the given string. Case insensitive. Matches both handle and title portions.
  • filter[createdAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z
  • filter[doneAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z
  • filter[updatedAt]: pipe-separate time range, e.g. 2021-01-01T00:00:00Z|2021-01-31T23:59:59Z
  • filter[environmentIds]: pipe-separated list of UUIDs, can include 'NONE'
  • filter[epicIds]: pipe-separated list of UUIDs, can include 'NONE'
  • filter[excludeTagIds]: pipe-separated list of tag UUIDs to exclude items that have any value from these tags
  • filter[excludeTagValueIds]: pipe-separated list of tag value UUIDs to exclude items with these specific tag values
  • filter[externalId]: pipe-separated list of a hasExternalId flag and an optional keyword search, e.g. 'true|HOTH', 'false'
  • filter[productThemeIds]: pipe-separated list of UUIDs, can include 'NONE'
  • filter[riskRating]: pipe-separated range of integers, e.g. 2|24 or 'NONE',
  • filter[sizeIds]: pipe-separated list of UUIDs, can include 'NONE'
  • filter[stepIds]: pipe-separated list of valid UUIDs only
  • filter[stepExpressions]: Filter with an expression that identify one or more step names within a step category. Case insensitive. Repeatable parameter to filter by more than one step category.
  • filter[tagIds]: pipe-separated list of tag UUIDs to filter items that have any value from these tags
  • filter[tagValueIds]: pipe-separated list of tag value UUIDs to filter items with these specific tag values
  • filter[teamIds]: pipe-separated list of UUIDs, can include 'NONE'
  • filter[timeboxIds]: pipe-separated list of UUIDs, can include 'NONE'
  • filter[triageGroup]: The only supported value is 'TRIAGE'
  • filter[type]: pipe-separated list of ItemType values, e.g. 'STORY|BUG' or single value 'STORY'
cursorstring nullable
sizeinteger nullable

Response

findBacklogItems 200 response

metaunknown
linksunknown

Changes

No recorded changes to this operation across all 1 revision of this API.