Tasks

List tasks

Get a list of tasks with filters for status, category, type, domain, and assignee.

get/v1/tasks

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/tasks
  • Auth: HTTP bearer

Query parameters

fieldsstring

Fields to include in response

status'Open' | 'InProgress' | 'Pending' | 'Approved' | 'Granted' | 'ManualRevoke' | 'Rejected' | 'Completed' | 'Cancelled' | 'Failed' | 'Revoked' | 'Expired'

Filter by task status

statusGroupstring

Filter by status group: 'open' for Open tasks, 'closed' for Approved/Rejected/Completed/Cancelled/Failed tasks

category'Approval' | 'DataAccess' | 'MetadataUpdate' | 'Incident' | 'Review' | 'Custom'

Filter by task category

type'GlossaryApproval' | 'RequestApproval' | 'DataAccessRequest' | 'DescriptionUpdate' | 'TagUpdate' | 'OwnershipUpdate' | 'TierUpdate' | 'DomainUpdate' | 'Suggestion' | 'TestCaseResolution' | 'IncidentResolution' | 'PipelineReview' | 'DataQualityReview' | 'RecognizerFeedbackApproval' | 'CustomTask'

Filter by task type

domainstring

Filter by domain FQN

priority'Critical' | 'High' | 'Medium' | 'Low'

Filter by priority

assigneestring

Filter by assignee (user or team FQN)

createdBystring

Filter by creator FQN

createdByIdstring uuid

Filter by creator user id

aboutEntitystring

Filter by entity FQN the task is about

aboutServicestring

Filter by parent service FQN of the entity the task is about

approverstring

Filter by approver FQN (user who approved the task)

approverIdstring uuid

Filter by approver user id

mentionedUserstring

Filter by user FQN who was mentioned in task comments

limitinteger

Limit the number results

beforestring

Returns list of tasks before this cursor

afterstring

Returns list of tasks after this cursor

startTsinteger

Filter by tasks created on or after this timestamp (epoch millis)

endTsinteger

Filter by tasks created on or before this timestamp (epoch millis)

include'all' | 'deleted' | 'non-deleted'

Include deleted tasks

Response

List of tasks

warningsCountinteger

Changes

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