List Tasks - Plugixa CRM for WordPress

List Tasks - Plugixa CRM

GET /plugixa-crm/v1/tasks

List tasks, one page at a time.

Any user with access to Plugixa CRM. With Plugixa CRM Pro roles, the list only holds the tasks the user’s role lets them read.

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/tasks?status=planned&parent_type=account&parent_id=12

Query parameters

Name	Type	Description
`status`	`string`	`planned`, `in_progress`, `completed` or `canceled`.
`priority`	`string`	`low`, `normal`, `high` or `urgent`.
`parent_type`	`string`	With `parent_id`: only those of this record. `account` also returns those of the account’s contacts and opportunities.
`parent_id`	`integer`	With `parent_type`.

Plus the list parameters every paged list accepts. search matches the name only. orderby accepts id, name, status, priority, date_start, date_due, created_at, modified_at. Field filters (field__operator=value, see Filters) work on assigned_user_id, created_at, modified_at, status, priority, date_due, date_start, plus Pro custom fields marked filterable.

Responses

`200` OK. `data` is one page of tasks.

{
  "success": true,
  "data": [
    {
      "id": 35,
      "name": "Send the renewal quote",
      "status": "planned",
      "priority": "high",
      "description": "",
      "date_start": null,
      "date_due": "2026-11-19 17:00:00",
      "is_all_day": 0,
      "color": "amber",
      "parent_type": "opportunity",
      "parent_id": 24,
      "account_id": 12,
      "assigned_user_id": 3,
      "completed_at": null,
      "created_by": "1",
      "modified_by": "1",
      "created_at": "2026-11-12 09:30:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null,
      "parent_name": "Northwind Traders: platform licence",
      "assigned_user_name": "Jordan Lee"
    }
  ],
  "meta": {
    "total": 16,
    "pages": 1
  }
}

Field	Type	Meaning
`data[].id`	`integer`	The task’s id
`data[].status`	`string`	`planned`, `in_progress`, `completed` or `canceled`
`data[].priority`	`string`	`low`, `normal`, `high` or `urgent`
`data[].date_start`	`string\|null`	Site time zone
`data[].date_due`	`string\|null`	Site time zone
`data[].parent_type`	`string\|null`	`contact`, `account`, `opportunity` or `lead`
`meta.total`	`integer`	Tasks matching, before paging
`meta.pages`	`integer`	Number of pages at this `per_page`

Errors

Status	Code	When
`400`	`plugixa_crm_unknown_filter`	A `field__operator` parameter names a field this list cannot filter on.
`400`	`plugixa_crm_unknown_operator`	The operator does not work on that field’s type.
`400`	`plugixa_crm_missing_value`	The filter needs a value, or two for `between`.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-crm/v1/tasks?status=planned&parent_type=account&parent_id=12" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'status'      => 'planned',
    'parent_type' => 'account',
    'parent_id'   => 12,
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-crm/v1/tasks?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const query = new URLSearchParams({ status: 'planned', parent_type: 'account', parent_id: '12' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-crm/v1/tasks?${query}`, {
  headers: {
    'Authorization': auth,
  },
});
const { data, meta } = await response.json();