Contents
On this page

Get Task - Plugixa CRM

GET /plugixa-crm/v1/tasks/{id}

Read one task, with its reminders.

Any user with access to Plugixa CRM. With Plugixa CRM Pro roles, the user’s role must also allow reading this task.

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/tasks/35

Path parameters

Name Type Description
id integer The task’s id

Responses

200 OK. data is the task.

{
  "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",
    "reminders": [
      {
        "id": 9,
        "seconds_before": 3600,
        "sent": 0
      }
    ]
  }
}
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
data.parent_id integer|null The record the task hangs off
data.account_id integer|null The account the parent rolls up to, worked out for you
data.completed_at string|null UTC datetime it was completed
data.parent_name string|null The parent record’s name
data.assigned_user_name string|null The owner’s display name
data.reminders array Reminders on the task: seconds_before and whether it was sent. Empty when the Reminders app is off

Errors

Status Code When
404 plugixa_crm_not_found No task with that id, or it is in the trash.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-crm/v1/tasks/35" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-crm/v1/tasks/35');
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 response = await fetch('https://your-site.example/wp-json/plugixa-crm/v1/tasks/35', {
  headers: {
    'Authorization': auth,
  },
});
const { data } = await response.json();

Quick Links

Share