Contents
On this page

Get Lead - Plugixa CRM

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

Read one lead.

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

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/leads/22

Path parameters

Name Type Description
id integer The lead’s id

Responses

200 OK. data is the lead.

{
  "success": true,
  "data": {
    "id": 22,
    "salutation": "",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "full_name": "Ada Lovelace",
    "account_name": "Analytical Engines Ltd",
    "title": "CTO",
    "email": "ada@analytical.example",
    "phone": "",
    "website": "https://analytical.example",
    "status": "new",
    "source": "web_site",
    "industry": "Software",
    "score": 40,
    "opportunity_amount": 12000,
    "opportunity_currency": "EUR",
    "address_city": "London",
    "address_country": "United Kingdom",
    "description": "",
    "converted_at": null,
    "converted_account_id": null,
    "converted_contact_id": null,
    "converted_opportunity_id": null,
    "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",
    "address_street": "",
    "address_state": "",
    "address_postal_code": ""
  }
}
Field Type Meaning
data.id integer The lead’s id
data.full_name string First and last name
data.account_name string The company, as free text
data.status string new, assigned, in_process, converted, recycled or dead
data.source string Where the lead came from, free text such as web_site
data.score integer 0 to 100
data.opportunity_amount number The expected deal value
data.opportunity_currency string Three-letter currency code
data.assigned_user_id integer|null The WordPress user who owns the lead
data.converted_at string|null UTC datetime of the conversion
data.converted_account_id integer|null The account the conversion used or created
data.converted_contact_id integer|null The contact it created
data.converted_opportunity_id integer|null The opportunity it created
data.do_not_call string "1" or "0"
data.created_at string UTC datetime

Errors

Status Code When
404 plugixa_crm_not_found No lead 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/leads/22" \
  -u "admin:$WP_APP_PASSWORD"

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

Quick Links

Share