Task Report

POST /api/reports/tasks/{crm_id}

Overview

Returns task records within a specific date range, including key details such as status, assignment, impact, and lead association. Supports pagination.

Important: This report is CRM-specific and will only return data for the branch or system associated with the {SHAPE_API_KEY} provided in the authorization header. If you need to pull data across multiple branches, you’ll need to call this endpoint separately for each one.

Endpoint

  • POST

    https://secure-api.setshape.com/api/reports/tasks/{crm_id}

Headers

  • Authorization: {SHAPE_API_KEY}

Request Parameters

Send the following parameters in the request body under the filters object:

  • Parameter

    fromDate


    toDate


    slctPerPage


    pn

  • Type

    String


    String


    Number


    Number

  • Description

    Start date of the report (YYYY-MM-DD)

    End date of the report (YYYY-MM-DD)

    Number of results per page


    Page number (for pagination)

Example Request Body

{

  “filters”: {

    “fromDate”: “2025-08-01”,

    “toDate”: “2025-08-08”,

    “slctPerPage”: 3,

    “pn”: 1

  }

}

Sample Response

{

  “status”: 1,

  “msg”: “Success”,

  “data”: [

    {

      “status”: “Not Started”,

      “leadType”: “Luis Santos”,

      “title”: “call “,

      “description”: “he had late payments and a low score – 516 – needed 12 months”,

      “eventDate”: “08/01/2025”,

      “fromTime”: “08:00 AM”,

      “impact”: “Low”,

      “userId”: “James Padgett”,

      “createdBy”: “James Padgett”

    },

    {

      “status”: “Not Started”,

      “leadType”: “Renee Crawford”,

      “title”: “fu mtg late”,

      “description”: “”,

      “eventDate”: “08/06/2025”,

      “fromTime”: “12:00 PM”,

      “impact”: “Low”,

      “userId”: “Eric Arnold”,

      “createdBy”: “Eric Arnold”

    },

    {

      “status”: “Not Started”,

      “leadType”: “Jason Blain”,

      “title”: “late pay in July 2024 – call about ontime pmts?  refi”,

      “description”: “”,

      “eventDate”: “08/04/2025”,

      “fromTime”: “12:00 PM”,

      “impact”: “Low”,

      “userId”: “Gwyn May”,

      “createdBy”: “Gwyn May”

    }

  ]

}

Field Descriptions

  • Field

    status


    leadType


    title


    description


    eventDate


    fromTime


    impact


    userId


    createdBy

  • Description

    Current status of the task (e.g., Not Started, In Progress, Completed) (YYYY-MM-DD)

    The contact or lead name associated with the task

    Short title or subject of the task


    Additional context or notes tied to the task


    Date the task is scheduled for


    Time the task is set to begin


    Priority or impact level (e.g., Low, Medium, High)

    Assigned user who is responsible for the task


    User who created the task

Notes

  • Be sure to replace {crm_id} in the URL with the actual CRM instance ID you want to query.
  • Dates must be in the format YYYY-MM-DD.
  • If you’re paging through a large result set, adjust slctPerPage and pn as needed.

Get started with Shape today