Contents
On this page

List Calls - Plugixa CRM

GET /plugixa-crm/v1/calls

List calls, one page at a time.

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

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/calls?status=planned&parent_type=contact&parent_id=31

Query parameters

Name Type Default Description
status string planned, completed or canceled.
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, date_start, created_at, modified_at. This list has no field filters of its own. With Pro, custom fields marked filterable can be used (cf_ and the field key, as in Filters); without them, field__operator parameters are ignored.

Responses

200 OK. data is one page of calls.

{
  "success": true,
  "data": [
    {
      "id": 17,
      "name": "Discovery call",
      "status": "planned",
      "direction": "outbound",
      "description": "",
      "date_start": "2026-11-18 14:00:00",
      "date_end": "2026-11-18 14:30:00",
      "is_all_day": 0,
      "color": null,
      "parent_type": "contact",
      "parent_id": 31,
      "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": "Maria Anders",
      "assigned_user_name": "Jordan Lee"
    }
  ],
  "meta": {
    "total": 16,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The call’s id
data[].status string planned, completed or canceled
data[].direction string outbound or inbound
data[].date_start string|null Site time zone
data[].date_end string|null Site time zone
data[].parent_type string|null contact, account, opportunity or lead
meta.total integer Calls matching, before paging
meta.pages integer Number of pages at this per_page

Errors

Plus the errors every endpoint can return.

Examples

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

<?php
$query = http_build_query([
    'status'      => 'planned',
    'parent_type' => 'contact',
    'parent_id'   => 31,
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-crm/v1/calls?' . $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: 'contact', parent_id: '31' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-crm/v1/calls?${query}`, {
  headers: {
    'Authorization': auth,
  },
});
const { data, meta } = await response.json();

Quick Links

Share