Get All Tasks

get

https://api.elliemae.com/workflow/v1/tasks

Returns a list of tasks. Return all task data or retrieve a specific set of tasks using the query parameters.

Usage Notes

The taskTypeName attribute is stored in the metadata object. To retrieve the taskTypeName (if exists), pass the query parameter metaData=true.

Pagination

Offset-based pagination and Page-based pagination is supported.
Offset-based pagination is achieved by passing "start" and "limit" query parameters. For example: GET workflow/v1/tasks?start=0&limit=20.
Page-based pagination is achieved by passing "page" and "size" query parameters. For example: GET workflow/v1/tasks?page=0&size=20.

Query Params

loanId

string

The unique identifier assigned to the loan. Also known as GUID.

assignee

string

Primary assignee of the task.

assigneeEntityId

string

Assignee Entity Id

assigneeEntityType

string

Assignee Entity Type

assigneeEntityTypes

string

Comma-separated list of strings for assignee entity types.

associationEntityId

string

Association Entity ID

associationEntityIds

string

Comma-separated list of strings for association entity IDs.

associationEntityType

string

Association Entity Type

associationEntityTypes

string

Comma-separated list of strings for association entity types.

createdDate

string

The task creation date from which the query start from and returning up to current date. (Date Format MM-DD-YYYY)

fromCreatedDate

string

The task creation date from which to start the query. (Date Format MM-DD-YYYY)

toCreatedDate

string

The task creation date from which to end the query. (Date Format MM-DD-YYYY)

completedDate

string

The task completion date from which the query start from and returning up to current date. (Date Format MM-DD-YYYY)

fromCompletedDate

string

The task completion date from which to start the query. (Date Format MM-DD-YYYY or MM-DD-YYYY hh:mm:ss)

toCompletedDate

string

The task completion date from which to end the query. (Date Format MM-DD-YYYY or MM-DD-YYYY hh:mm:ss)

dueDate

string

The task due date from which the query start from and returning up to current date. (Date Format MM-DD-YYYY)

fromDueDate

string

The task due date from which to start the query. (Date Format MM-DD-YYYY)

toDueDate

string

The task due date from which to end the query. (Date Format MM-DD-YYYY)

limit

integer

The maximum number of entities to return as part of the collection

metadata

boolean

Indicates whether to include metadata.

lastModifiedDate

string

The task last modified date from which the query start from and returning up to current date. (Date Format MM-DD-YYYY)

fromLastModifiedDate

string

The task last modified date from which to start the query. (Date Format MM-DD-YYYY)

toLastModifiedDate

string

The task last modified date from which to end the query. (Date Format MM-DD-YYYY)

name

string

The task name.

page

integer

Zero-based indicator of the page.

partial

boolean

Specify True to indicate partial properties to be returned in the query. The default is False.

partialList

string

Comma-separated list of partial properties to be returned. Only applicable if partial is set to True.

priority

integer

Priority number of the task.

relationship

string

Relationship to Task Service.

relationships

string

Comma-separated list of strings for relationships.

resolution

string

The resolution or disposition for the task.

size

integer

The maximum number of entities to return as part of the page.

start

integer

Zero-based indicator of first collection entity.

startDate

string

The task start date from which the query start from and returning up to current date. (Date Format MM-DD-YYYY)

fromStartDate

string

The task start date from which to start the query. (Date Format MM-DD-YYYY)

toStartDate

string

The task start date from which to end the query. (Date Format MM-DD-YYYY)

sortBy

string

Comma-separated list of properties names in which to sort.

statusIn

string

Comma-separated list of statuses for task to be returned.

200OK