Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-224341,4072.0 MB
Task

Search

Search tasks based on filters specified in the request body.

post/api/v1/search/tasks

Request body

accessReviewIdsstring[] nullable

Search tasks that belong to any of the access reviews included in this list.

accountOwnerIdsstring[] nullable

Search tasks that have any of these account owners.

accountTypesstring[] nullable

The accountTypes field.

actorIdstring

Search tasks that have this actor ID.

appEntitlementIdsstring[] nullable

Search tasks that have any of these app entitlement IDs.

appResourceIdsstring[] nullable

Search tasks that have any of these app resource IDs.

appResourceTypeIdsstring[] nullable

Search tasks that have any of these app resource type IDs.

appUserSubjectIdsstring[] nullable

Search tasks that have any of these app users as subjects.

applicationIdsstring[] nullable

Search tasks that have any of these apps as targets.

assignedOrStepApproverUserIdstring

Search tasks that are currently assigned to this user, or that are closed and were previously approved by this user.

assigneesInIdsstring[] nullable

Search tasks by List of UserIDs which are currently assigned these Tasks

certifyOutcomesstring[] nullable

Search tasks by certify outcome

createdAfterstring date-time
createdBeforestring date-time
currentStep'TASK_SEARCH_CURRENT_STEP_UNSPECIFIED' | 'TASK_SEARCH_CURRENT_STEP_APPROVAL' | 'TASK_SEARCH_CURRENT_STEP_PROVISION'

Search tasks that have this type of step as the current step.

emergencyStatus'UNSPECIFIED' | 'ALL' | 'NON_EMERGENCY' | 'EMERGENCY'

Search tasks that are or are not emergency access.

excludeAppEntitlementIdsstring[] nullable

Search tasks that do not have any of these app entitlement IDs.

excludeAppResourceTypeIdsstring[] nullable

Search tasks that do not have any of these app resource type IDs.

excludeApplicationIdsstring[] nullable

Search tasks that do NOT have any of these apps as targets.

excludeIdsstring[] nullable

Exclude Specific TaskIDs from this serach result.

grantOutcomesstring[] nullable

Search tasks by grant outcome

includeActedAfterstring date-time
includeDeletedboolean

Whether or not to include deleted tasks.

myWorkUserIdsstring[] nullable

Search tasks where the user would see this task in the My Work section

olderThanDurationstring duration
openerIdsstring[] nullable

Search tasks that were created by any of the users in this array.

openerOrSubjectUserIdstring

Search tasks that were opened by this user, or that the user is the subject of.

outcomeAfterstring date-time
outcomeBeforestring date-time
pageSizeinteger

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

pageTokenstring

The pageToken field.

pendingActionFilter'PENDING_ACTION_FILTER_UNSPECIFIED' | 'PENDING_ACTION_FILTER_WITH_PENDING' | 'PENDING_ACTION_FILTER_WITHOUT_PENDING'

Filter tasks by pending action status. Only applies when exactly one access_review_id is specified. Requires the REVIEWS_PENDING_ACTIONS feature flag to be enabled.

previouslyActedOnIdsstring[] nullable

Search tasks that were acted on by any of these users.

querystring

Fuzzy search tasks by display name, description, or ID.

requireApprovalReasonboolean

Filter tasks where the current approval step requires an approval reason.

requireDenialReasonboolean

Filter tasks where the current approval step requires a denial reason.

revokeOutcomesstring[] nullable

Search tasks by revoke outcome

sortBy'TASK_SEARCH_SORT_BY_UNSPECIFIED' | 'TASK_SEARCH_SORT_BY_ACCOUNT' | 'TASK_SEARCH_SORT_BY_RESOURCE' | 'TASK_SEARCH_SORT_BY_ACCOUNT_OWNER' | 'TASK_SEARCH_SORT_BY_REVERSE_TICKET_ID' | 'TASK_SEARCH_SORT_BY_TICKET_ID' | 'TASK_SEARCH_SORT_BY_CREATED_AT' | 'TASK_SEARCH_SORT_BY_REVERSE_CREATED_AT' | 'TASK_SEARCH_SORT_BY_APP_RESOURCE_ID_AND_APP_ENTITLEMENT'

Sort tasks in a specific order.

stepApprovalTypesstring[] nullable

Search tasks that have a current policy step of this type

subjectIdsstring[] nullable

Search tasks where these users are the subject.

taskStatesstring[] nullable

Search tasks with this task state.

userEmploymentStatusesstring[] nullable

The userEmploymentStatuses field.

Response

The TaskSearchResponse message contains a list of results and a nextPageToken if applicable.

nextPageTokenstring

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.