List CRM Providers - Plugixa Chat for WordPress

List CRM Providers - Plugixa Chat

GET /plugixa-chat/v1/crm/providers

List the services a connection can use, and whether each is ready on this site.

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/providers

Responses

`200` OK.

{
  "success": true,
  "data": [
    {
      "slug": "mailchimp",
      "label": "Mailchimp",
      "needsKey": true,
      "available": true,
      "supports": [
        "tags",
        "double_optin"
      ]
    },
    {
      "slug": "brevo",
      "label": "Brevo",
      "needsKey": true,
      "available": true,
      "supports": []
    },
    {
      "slug": "fluentcrm",
      "label": "FluentCRM",
      "needsKey": false,
      "available": false,
      "supports": [
        "tags",
        "double_optin"
      ]
    }
  ]
}

Field	Type	Meaning
`data[].slug`	`string`	What a connection sends as `provider`
`data[].needsKey`	`boolean`	Whether an `api_key` is required
`data[].available`	`boolean`	Whether it can be used now. FluentCRM is available only while the FluentCRM plugin is active
`data[].supports`	`array`	`tags` and `double_optin` when the service honours them

Errors

Plus the errors every endpoint can return.

Examples

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

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