Contents
On this page

Get Account - Plugixa CRM

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

Read one account, with the contacts linked to it and its child accounts.

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

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/accounts/12

Path parameters

Name Type Description
id integer The account’s id

Responses

200 OK. data is the account.

{
  "success": true,
  "data": {
    "id": "12",
    "name": "Northwind Traders",
    "type": "customer",
    "industry": "Wholesale",
    "website": "https://northwind.example",
    "email": "hello@northwind.example",
    "phone": "+1 202 555 0143",
    "billing_street": "",
    "billing_city": "Seattle",
    "billing_state": "WA",
    "billing_postal_code": "98101",
    "billing_country": "United States",
    "shipping_street": "",
    "shipping_city": "",
    "shipping_state": "",
    "shipping_postal_code": "",
    "shipping_country": "",
    "parent_id": null,
    "description": "",
    "status": "active",
    "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,
    "sic_code": "",
    "contacts": [
      {
        "id": 7,
        "account_id": 12,
        "contact_id": 31,
        "role": "Buyer",
        "is_primary": 1,
        "is_inactive": 0,
        "created_at": "2026-11-12 09:30:00",
        "full_name": "Maria Anders",
        "title": "Purchasing manager",
        "email": "maria@northwind.example"
      }
    ],
    "children": []
  }
}
Field Type Meaning
data.id string The account’s id. Account fields come back as strings, numbers included
data.name string The account’s name
data.type string customer, prospect, partner or supplier
data.status string Free text, active unless you set something else
data.parent_id string|null The parent account’s id
data.assigned_user_id string|null The WordPress user who owns the account
data.created_at string UTC datetime
data.modified_at string UTC datetime of the last change
data.deleted_at string|null UTC datetime it was moved to the trash, else null
data.contacts array The contacts linked to the account, primary links first: the link (id, role, is_primary) plus the contact’s full_name, title and email
data.children array Live accounts whose parent is this one, by name, at most 200

Errors

Status Code When
404 plugixa_crm_not_found No account 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/accounts/12" \
  -u "admin:$WP_APP_PASSWORD"

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

Quick Links

Share