Search Application Tasks

get

https://api.cloud.digifi.io/tasks/search

The Search Tasks API can be used to search for existing application tasks.

This API uses query parameters (no JSON body). Below please find descriptions of the parameters.

Caution

The Search API provides guarantees of eventual consistency and under normal operating conditions, data propagation takes seconds. For read-after-write workflows requiring strict consistency, use the "List Application Tasks" method instead.

Query Params

count

number

1 to 100

Defaults to 20

Number of entities to return. Used for pagination implementation. If no value is provided used default 20. Max 100.

offset

number

≥ 0

Number entities to skip. Useful for pagination implementation. Only works if count param is passed

sortField

string

enum

Field to sort by

Allowed:

sortDirection

string

enum

Direction of sort results. asc or desc

Allowed:

string

Search query to perform

statuses

array of strings

Array of task statuses. Can be Done, In Progress, Cancelled, Failed, In Review, Not Done (maximum 6 values in array)

statuses

assignedTeamMemberIds

array of strings

Array of assigned team member IDs (maximum 100 values in array)

assignedTeamMemberIds

externalAssigneeId

string

External assignee Id

externalAssigneeType

string

enum

External assignee type. Can be borrower or intermediary.

Allowed:

updatedDateFrom

string

Updated from date in ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) format.

updatedDateTo

string

Updated to date in ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) format.

dueDateFrom

string

Due from date in ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) format.

dueDateTo

string

Due to date in ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) format.

applicationId

string

Application ID

productId

string

Product ID

labelIds

array of strings

Array of task label IDs (maximum 100 values in array)

labelIds

groups

array of strings

Array of groups (maximum 100 values in array, each value with a maximum length of 248 characters)

groups

Headers

api-version

string

enum

Defaults to 2024-02-26

Allowed:

Responses

200Success

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error