List Contacts - Plugixa CRM for WordPress

List Contacts - Plugixa CRM

GET /plugixa-crm/v1/contacts

List contacts (people), one page at a time.

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

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/contacts?account_id=12

Query parameters

Name	Type	Default	Description
`account_id`	`integer`		Contacts whose primary account is this one. Contacts only linked to it as a secondary account are not included.

Plus the list parameters every paged list accepts. search matches the full name and the primary e-mail address. orderby accepts id, full_name, last_name, email, title, created_at, modified_at. Field filters (field__operator=value, see Filters) work on assigned_user_id, created_at, modified_at, account_id, title, email, plus Pro custom fields marked filterable.

Responses

`200` OK. `data` is one page of contacts.

{
  "success": true,
  "data": [
    {
      "id": "31",
      "salutation": "Ms",
      "first_name": "Maria",
      "last_name": "Anders",
      "full_name": "Maria Anders",
      "account_id": "12",
      "title": "Purchasing manager",
      "email": "maria@northwind.example",
      "phone": "+1 202 555 0177",
      "description": "",
      "avatar_attachment_id": null,
      "user_id": null,
      "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,
      "do_not_call": "0",
      "birthday": null,
      "address_street": "",
      "address_city": "Seattle",
      "address_state": "",
      "address_postal_code": "",
      "address_country": "United States"
    }
  ],
  "meta": {
    "total": 4,
    "pages": 1
  }
}

Field	Type	Meaning
`data[].id`	`string`	The contact’s id. Contact fields come back as strings, numbers included
`data[].full_name`	`string`	First and last name, kept in step with them
`data[].account_id`	`string\|null`	The primary account
`data[].email`	`string`	The primary e-mail address
`data[].phone`	`string`	The primary phone number
`meta.total`	`integer`	Contacts matching, before paging
`meta.pages`	`integer`	Number of pages at this `per_page`

List rows are the contact alone. Get Contact adds every e-mail address, phone number and linked account.

Errors

Status	Code	When
`400`	`plugixa_crm_unknown_filter`	A `field__operator` parameter names a field this list cannot filter on.
`400`	`plugixa_crm_unknown_operator`	The operator does not work on that field’s type.
`400`	`plugixa_crm_missing_value`	The filter needs a value, or two for `between`.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-crm/v1/contacts?account_id=12" \
  -u "admin:$WP_APP_PASSWORD"

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