Contents
On this page

Get Case - Plugixa CRM

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

Read one case, with the ids of the contacts involved.

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

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/cases/42

Path parameters

Name Type Description
id integer The case’s id

Responses

200 OK. data is the case.

{
  "success": true,
  "data": {
    "id": 42,
    "name": "Invoice shows the wrong VAT number",
    "status": "assigned",
    "priority": "high",
    "type": "problem",
    "description": "<p>The October invoice carries the old VAT number.</p>",
    "account_id": 12,
    "contact_id": 31,
    "lead_id": null,
    "is_internal": false,
    "closed_at": null,
    "assigned_user_id": 3,
    "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,
    "number": "C-00042",
    "number_value": 42,
    "is_closed": false,
    "account_name": "Northwind Traders",
    "contact_name": "Maria Anders",
    "assigned_user_name": "Jordan Lee",
    "contacts": [
      31
    ]
  }
}
Field Type Meaning
data.id integer The case’s id
data.number string The case reference, C- and a padded sequence number
data.number_value integer The sequence number alone
data.name string The subject
data.status string new, assigned, pending, closed, rejected or duplicate
data.priority string low, normal, high or urgent
data.type string question, incident, problem, or empty
data.is_internal boolean Whether the case is internal
data.is_closed boolean true for closed, rejected and duplicate
data.closed_at string|null When the case was closed, in the site’s time zone
data.account_name string The account’s name, empty when none
data.contact_name string The contact’s name, empty when none
data.assigned_user_name string The owner’s display name, empty when none
data.contacts array The ids of the contacts involved

Errors

Status Code When
404 plugixa_crm_not_found No case 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/cases/42" \
  -u "admin:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-crm/v1/cases/42');
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/cases/42', {
  headers: {
    'Authorization': auth,
  },
});
const { data } = await response.json();

Quick Links

Share