Backlog Items

Lists all the backlog items

get/api/backlog_items

Request

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

Query parameters

includeBacklogItemControllerInclusionType[] required

Supports ASSIGNEE, CREATOR, CYCLE_TIME, EPIC, EPIC_STORIES, FEATURE_FLAG, ITEM_TIMES_TEAM_STATS, PRODUCT_THEME, RISK_RATING, SPRINT, STEP, SUBTASK_COUNT, TAG_VALUES, TEAM and TIMEBOX. Ignores ACCEPTANCE_CRITERIA, ATTACHMENTS, COMMENTS, LINKED_ITEMS, LINKED_ITEMS_STEPS and SUBTASKS.

savedViewIdstring uuid nullable
assigneeIdsstring nullable
createdAtstring nullable
cycleTimeMode'NORMAL' | 'OUTLIER'
doneAtstring nullable
environmentIdsstring nullable
excludeLinkedItemIdstring uuid nullable
externalIdstring nullable
keywordSearchstring nullable
productThemeIdsstring nullable
epicIdsstring nullable
riskRatingstring nullable
sizeIdsstring nullable
sprintIdsstring nullable
stepIdsstring nullable
teamIdsstring nullable
teams'ALL' | 'ACTIVE' | 'PUBLIC' | 'SPECIFIED' | 'USER_RELATED' | 'USER_RELATED_WITH_DELETED'
timeboxIdsstring nullable
triageGroup'TRIAGE' | 'NOT_TRIAGED' | 'INFO_REQUIRED' | 'REJECTED'
typestring nullable
updatedAtstring nullable
isFollowedByUserstring uuid nullable
isNotFollowedByUserstring uuid nullable
tagValueIdsstring nullable
tagIdsstring nullable
excludeTagValueIdsstring nullable
excludeTagIdsstring nullable

Filter for backlog items. Notes about specific filter parameters

  • 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[environmentIds]: 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[epicIds]: 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[sprintIds]: 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[teamIds]: pipe-separated list of UUIDs, can include 'NONE'
  • filter[teams]: possible values:
    • ALL: List items from all active team and unassigned backlogs. Some item details may be hidden based on user permissions.
    • SPECIFIED: List only items from specified team or unassigned backlogs
    • USER_RELATED: List only items from unassigned backlog or backlogs of public teams or of private teams the user is a member or an admin of
    • USER_RELATED_WITH_DELETED: Similar to USER_RELATED but also includes items from deleted teams
  • 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'
page[number]integer nullable

Returns a specific page of results, starting from page 0. Use with page[size] to control how many items are returned per page. For example, if page[size] is 20, then page[number]=2 returns items 21-40.

page[size]integer nullable

Controls how many items are returned in each response page.

page[offset]integer nullable

Skips the specified number of items before starting the result set. For example, if page[offset] is 30 and page[size] is 10, the response returns items 31-40.

sortstring[] required
privateItemsAtEndboolean required

Whether to place private/censored items at the end of the list. If false, items maintain their original order with censoring applied in place.

Response

listBacklogItems 200 response

metaunknown
linksunknown

Changes

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