List Tasks

GET https://api.chartmogul.com/v1/tasks

Lists task objects in your ChartMogul account.

curl -X GET "https://api.chartmogul.com/v1/tasks?customer_uuid=cus_f466e33d-ff2b-4a11-8f85-417eb02157a7&per_page=20&cursor=aabbcc..." \
     -u YOUR_API_KEY: \

ChartMogul::Task.all(
  per_page: 20,
  cursor: "aabbcc...",
  customer_uuid: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
)

ChartMogul.Task.all(config, {
  per_page: 20,
  cursor: "aabbccdd...",
  customer_uuid: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
});

ChartMogul\Task::all([
  "customer_uuid" => "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
  "cursor" => "aabbccdd...",
  "per_page" => "20"
]);

api.ListTasks(&cm.ListTasksParams{
  Cursor:       cm.Cursor{PerPage: 1},
  CustomerUUID: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
})

chartmogul.Task.all(
  config,
  cursor="aabbcc...",
  per_page=20,
  customer_uuid="cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
)

{
  "entries": [
    {
      "task_uuid": "5d6ec2cc-280d-11f0-b50e-5bd43fc8c28c",
      "customer_uuid": "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      "task_details": "Schedule product demo",
      "assignee": "[email protected]",
      "due_date": "2025-04-21",
      "completed_at": "2025-04-20",
      "created_at": "2025-04-20T08:06:31.644Z",
      "updated_at": "2025-04-20T08:06:31.644Z"
    }
    // ...and more
  ],
  "cursor": "aabbcc...",
  "has_more": true
}

#<ChartMogul::Task:0x00007f82834c9368 
@entries=[
  #<ChartMogul::Task:0x00000001058a8210
    @task_uuid="5d6ec2cc-280d-11f0-b50e-5bd43fc8c28c", 
    @created_at="2025-04-20T08:06:31.644Z", 
    @updated_at="2025-04-20T08:06:31.644Z",
    @customer_uuid="cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
    @task_details="Schedule product demo",
    @assignee="[email protected]", 
    @due_date="2025-04-21", 
    @completed_at="2025-04-20"
  >,
  # ...and more
  ],
  @has_more=true, 
  @cursor="aabbcc..."
>

{
  entries: [
    {
      task_uuid: "5d6ec2cc-280d-11f0-b50e-5bd43fc8c28c",
      customer_uuid: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      task_details: "Schedule product demo",
      assignee: "[email protected]",
      due_date: "2025-04-21",
      completed_at: "2025-04-20",
      created_at: "2025-04-20T08:06:31.644Z",
      updated_at: "2025-04-20T08:06:31.644Z"
    }
    // ...and more
  ],
  cursor: "aabbcc...",
  has_more: true
}

class ChartMogul\Resource\CollectionWithCursor (3) {
  public $has_more => bool(true)
  public $cursor => string(96) "aabbcc..."
  private $elements => array(20) {
    [0] =>
      class ChartMogul\Task (8) {
        protected $task_uuid => string(36) "5d6ec2cc-280d-11f0-b50e-5bd43fc8c28c"
        protected $customer_uuid => string(40) "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7"
        protected $task_details => string(21) "Schedule product demo"
        protected $assignee => string(20) "[email protected]"
        protected $due_date => string(10) "2025-04-21"
        protected $completed_at => string(10) "2025-04-20"
        protected $created_at => string(24) "2025-04-20T08:06:31.644Z"
        protected $updated_at => string(24) "2025-04-20T08:06:31.644Z"
      }
  // ...and more
  }
}

(*chartmogul.Tasks)(0x14000486b10)({
  Entries: ([]*chartmogul.Task) (len=20 cap=20) {
    (*chartmogul.Task)(0x140004032b0)({
      TaskUUID: (string) (len=36) "5d6ec2cc-280d-11f0-b50e-5bd43fc8c28c",
      CustomerUUID: (string) (len=40) "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      TaskDetails: (string) (len=21) "Schedule product demo",
      Assignee: (string) (len=20) "[email protected]",
      DueDate: (string) (len=10) "2025-04-21",
      CompletedAt: (string) (len=10) "2025-04-20",
      CreatedAt: (string) (len=24) "2025-04-20T08:06:31.644Z",
      UpdatedAt: (string) (len=24) "2025-04-20T08:06:31.644Z"
    }),
    // ...and more
  },
  Pagination: (chartmogul.Pagination) {
    Cursor: (string) (len=7) "88abf99",
    HasMore: (bool) false
  }
})

Tasks(
  entries=[
    <Task{
      "task_uuid": "5d6ec2cc-280d-11f0-b50e-5bd43fc8c28c",
      "customer_uuid": "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      "task_details": "Schedule product demo",
      "assignee": "[email protected]",
      "due_date": "2025-04-21",
      "completed_at": "2025-04-20",
      "created_at": "2025-04-20T08:06:31.644Z",
      "updated_at": "2025-04-20T08:06:31.644Z"
    }>,
    # ...and more
  ],
  has_more=True,
  cursor="aabbcc..."
)

Query parameters

customer_uuid string optional: The ChartMogul UUID of the customer for whom you want to list tasks.
assignee string optional: The email address of the ChartMogul user whose tasks you want to list.
due_date_on_or_after datetime optional: The lower limit of the due date range. Use this parameter to limit your results to tasks due on or after a certain date. Must be an ISO 8601-formatted date.
due_date_on_or_before datetime optional: The upper limit of the due date range. Use this parameter to limit your results to tasks due on or before a certain date. Must be an ISO 8601-formatted date.
completed boolean optional: Allows you to fetch either completed (true) or ongoing (false) tasks.
cursor string optional: A value that fetches the next page of tasks. To fetch the next page of tasks, set the cursor to the value received in the previous page response.
per_page int32 optional default: 200: A limit on the number of tasks to return per page. The default and maximum value is 200.

Response

The response object contains the following data:

entries: A list of task entries.
cursor: A reference to the next list of tasks.
has_more: Determines whether there are more tasks to query after this request. Returns true if there are and false if there aren’t.