ServiceReef

Back GET v1/tasks

Returns a list of track tasks

Request Information

URI Parameters

Name Description Type Additional information
status

Status of task (Uncompleted, Completed)

 TaskCompletionStatus
trackId

Filter by single track tasks.

 integer
userId

Filter all tasks for a track subscriber.

 integer
assignedToUserId

Filter all tasks assigned to a single user.

 integer
name

Filter tasks by the task name.

 string
completedFrom

Return tasks completed after from date

 date
completedTo

Return tasks completed before to date

 date
pageSize

Number of results to return (defaults to 25, max of 200)

 integer

Default value is 25
page

Page number (starting page is 1)

 integer

Default value is 1

Body Parameters

None.

Sample Request

https://api.servicereef.com/v1/tasks?status={status}&trackId={trackId}&userId={userId}&assignedToUserId={assignedToUserId}&name={name}&completedFrom={completedFrom}&completedTo={completedTo}&pageSize={pageSize}&page={page}

Response Information

Resource Description

TasksModel
Name Description Type Additional information
PageInfo

PageModel
Results

Collection of TaskProgressModel

Try API

Try this endpoint by entering your credentials and using the API Explorer.

Try With API Explorer

Response Formats

application/json, text/json

Sample: 
{
  "PageInfo": {
    "TotalRecords": 1,
    "Page": 2,
    "PageSize": 3
  },
  "Results": [
    {
      "TaskItemProgressId": 1,
      "Task": {
        "TaskId": 1,
        "TaskName": "sample string 2",
        "TaskType": "Checkbox"
      },
      "Track": {
        "TrackId": 1,
        "TrackName": "sample string 2"
      },
      "Subscriber": {
        "UserId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4"
      },
      "AssignedTo": {
        "UserId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4"
      },
      "DateCompleted": "2024-12-22T18:51:38.3605379Z",
      "DateCreated": "2024-12-22T18:51:38.3605379Z",
      "DateOpened": "2024-12-22T18:51:38.3605379Z",
      "DateDue": "2024-12-22T18:51:38.3605379Z",
      "CompletedBy": {
        "UserId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4"
      },
      "Status": "Incomplete",
      "Files": [
        {
          "Url": "sample string 1",
          "FileName": "sample string 2",
          "Title": "sample string 3",
          "Description": "sample string 4",
          "Source": "Unknown",
          "BrowserUrl": "sample string 5"
        },
        {
          "Url": "sample string 1",
          "FileName": "sample string 2",
          "Title": "sample string 3",
          "Description": "sample string 4",
          "Source": "Unknown",
          "BrowserUrl": "sample string 5"
        }
      ],
      "FormResponse": {
        "FormId": 1,
        "FormResponseId": 2,
        "FormName": "sample string 3",
        "DateCompleted": "2024-12-22T18:51:38.3605379Z",
        "Answers": [
          {
            "QuestionId": 1,
            "Question": "sample string 2",
            "HelpText": "sample string 3",
            "Answer": "sample string 4",
            "QuestionType": "Unknown"
          },
          {
            "QuestionId": 1,
            "Question": "sample string 2",
            "HelpText": "sample string 3",
            "Answer": "sample string 4",
            "QuestionType": "Unknown"
          }
        ],
        "UserId": 1
      },
      "References": [
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Email": "sample string 3",
          "DateSent": "2024-12-22T18:51:38.3605379Z",
          "DateCompleted": "2024-12-22T18:51:38.3605379Z",
          "FormResponse": {
            "FormId": 1,
            "FormResponseId": 2,
            "FormName": "sample string 3",
            "DateCompleted": "2024-12-22T18:51:38.3605379Z",
            "Answers": [
              {
                "QuestionId": 1,
                "Question": "sample string 2",
                "HelpText": "sample string 3",
                "Answer": "sample string 4",
                "QuestionType": "Unknown"
              },
              {
                "QuestionId": 1,
                "Question": "sample string 2",
                "HelpText": "sample string 3",
                "Answer": "sample string 4",
                "QuestionType": "Unknown"
              }
            ],
            "UserId": 1
          }
        },
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Email": "sample string 3",
          "DateSent": "2024-12-22T18:51:38.3605379Z",
          "DateCompleted": "2024-12-22T18:51:38.3605379Z",
          "FormResponse": {
            "FormId": 1,
            "FormResponseId": 2,
            "FormName": "sample string 3",
            "DateCompleted": "2024-12-22T18:51:38.3605379Z",
            "Answers": [
              {
                "QuestionId": 1,
                "Question": "sample string 2",
                "HelpText": "sample string 3",
                "Answer": "sample string 4",
                "QuestionType": "Unknown"
              },
              {
                "QuestionId": 1,
                "Question": "sample string 2",
                "HelpText": "sample string 3",
                "Answer": "sample string 4",
                "QuestionType": "Unknown"
              }
            ],
            "UserId": 1
          }
        }
      ]
    },
    {
      "TaskItemProgressId": 1,
      "Task": {
        "TaskId": 1,
        "TaskName": "sample string 2",
        "TaskType": "Checkbox"
      },
      "Track": {
        "TrackId": 1,
        "TrackName": "sample string 2"
      },
      "Subscriber": {
        "UserId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4"
      },
      "AssignedTo": {
        "UserId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4"
      },
      "DateCompleted": "2024-12-22T18:51:38.3605379Z",
      "DateCreated": "2024-12-22T18:51:38.3605379Z",
      "DateOpened": "2024-12-22T18:51:38.3605379Z",
      "DateDue": "2024-12-22T18:51:38.3605379Z",
      "CompletedBy": {
        "UserId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4"
      },
      "Status": "Incomplete",
      "Files": [
        {
          "Url": "sample string 1",
          "FileName": "sample string 2",
          "Title": "sample string 3",
          "Description": "sample string 4",
          "Source": "Unknown",
          "BrowserUrl": "sample string 5"
        },
        {
          "Url": "sample string 1",
          "FileName": "sample string 2",
          "Title": "sample string 3",
          "Description": "sample string 4",
          "Source": "Unknown",
          "BrowserUrl": "sample string 5"
        }
      ],
      "FormResponse": {
        "FormId": 1,
        "FormResponseId": 2,
        "FormName": "sample string 3",
        "DateCompleted": "2024-12-22T18:51:38.3605379Z",
        "Answers": [
          {
            "QuestionId": 1,
            "Question": "sample string 2",
            "HelpText": "sample string 3",
            "Answer": "sample string 4",
            "QuestionType": "Unknown"
          },
          {
            "QuestionId": 1,
            "Question": "sample string 2",
            "HelpText": "sample string 3",
            "Answer": "sample string 4",
            "QuestionType": "Unknown"
          }
        ],
        "UserId": 1
      },
      "References": [
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Email": "sample string 3",
          "DateSent": "2024-12-22T18:51:38.3605379Z",
          "DateCompleted": "2024-12-22T18:51:38.3605379Z",
          "FormResponse": {
            "FormId": 1,
            "FormResponseId": 2,
            "FormName": "sample string 3",
            "DateCompleted": "2024-12-22T18:51:38.3605379Z",
            "Answers": [
              {
                "QuestionId": 1,
                "Question": "sample string 2",
                "HelpText": "sample string 3",
                "Answer": "sample string 4",
                "QuestionType": "Unknown"
              },
              {
                "QuestionId": 1,
                "Question": "sample string 2",
                "HelpText": "sample string 3",
                "Answer": "sample string 4",
                "QuestionType": "Unknown"
              }
            ],
            "UserId": 1
          }
        },
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Email": "sample string 3",
          "DateSent": "2024-12-22T18:51:38.3605379Z",
          "DateCompleted": "2024-12-22T18:51:38.3605379Z",
          "FormResponse": {
            "FormId": 1,
            "FormResponseId": 2,
            "FormName": "sample string 3",
            "DateCompleted": "2024-12-22T18:51:38.3605379Z",
            "Answers": [
              {
                "QuestionId": 1,
                "Question": "sample string 2",
                "HelpText": "sample string 3",
                "Answer": "sample string 4",
                "QuestionType": "Unknown"
              },
              {
                "QuestionId": 1,
                "Question": "sample string 2",
                "HelpText": "sample string 3",
                "Answer": "sample string 4",
                "QuestionType": "Unknown"
              }
            ],
            "UserId": 1
          }
        }
      ]
    }
  ]
}