Contents
On this page

Get Call - Plugixa CRM

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

Read one call, with its participants and reminders.

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

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/calls/17

Path parameters

Name Type Description
id integer The call’s id

Responses

200 OK. data is the call.

{
  "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",
    "participants": [
      {
        "id": 21,
        "call_id": 17,
        "participant_type": "contact",
        "participant_id": 31,
        "acceptance": "none",
        "is_organizer": 0,
        "created_at": "2026-11-12 09:30:00",
        "participant_name": "Maria Anders"
      }
    ],
    "reminders": [
      {
        "id": 9,
        "seconds_before": 3600,
        "sent": 0
      }
    ]
  }
}
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
data.parent_id integer|null The record the call 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.participants array Who is on the call: participant_type (contact, lead or user), participant_id, participant_name, acceptance, is_organizer
data.reminders array Reminders on the call: seconds_before and whether it was sent. Empty when the Reminders app is off

Errors

Status Code When
404 plugixa_crm_not_found No call 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/calls/17" \
  -u "admin:$WP_APP_PASSWORD"

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

Quick Links

Share