Contents
On this page

Get CRM Connection - Plugixa Chat

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

Read one connection. Its API key is never included: has_key says whether one is stored.

Needs Plugixa Chat Pro. The signed-in user needs the plugixa_chat_view capability. Administrators have it.

Request

GET https://your-site.example/wp-json/plugixa-chat/v1/crm/6

Path parameters

Name Type Description
id integer The connection’s id

Responses

200 OK. data is the connection.

{
  "success": true,
  "data": {
    "id": 6,
    "provider": "mailchimp",
    "name": "Newsletter",
    "list_id": "a1b2c3d4e5",
    "list_name": "Newsletter",
    "tags": [
      "chat-lead"
    ],
    "double_optin": true,
    "audience": "subscribed",
    "widget_id": 0,
    "is_active": true,
    "last_status": 0,
    "last_error": "",
    "last_sent_at": null,
    "failures": 0,
    "deleted_at": null,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 09:30:00",
    "created_by": "1",
    "modified_by": "1",
    "has_key": true
  }
}
Field Type Meaning
data.id integer The connection’s id
data.provider string mailchimp, brevo or fluentcrm
data.list_id string The list contacts are added to
data.list_name string Its name, as you sent it
data.tags array Tags added to each contact
data.double_optin boolean Whether the service asks the contact to confirm
data.audience string subscribed (only leads who ticked the newsletter box) or everyone
data.widget_id integer Only leads from this widget, 0 for all
data.is_active boolean Whether leads are sent
data.last_status integer HTTP status of the last delivery, 0 before the first
data.last_error string Why the last delivery failed, empty otherwise
data.last_sent_at string|null When the last delivery was made, or null
data.failures integer Failures in a row
data.has_key boolean Whether an API key is stored. The key itself is never returned

Errors

Status Code When
404 plugixa_chat_not_found No connection has this id, or it is in the trash.

Plus the errors every endpoint can return.

Examples

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

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-chat/v1/crm/6');
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 response = await fetch('https://your-site.example/wp-json/plugixa-chat/v1/crm/6', {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();

Quick Links

Share