Portal Community

lead/get

Retrieve a single Lead record by its Salesforce ID.

When to Use

Configuration

Connection

FieldTypeRequiredDescription
InstanceUrlstringrequiredSalesforce org URL, e.g. https://myorg.my.salesforce.com
AccessTokenstringrequiredValid OAuth2 access token. Store in BizFirst Credentials Manager.

Operation Fields

FieldTypeRequiredDescription
LeadIdstringrequired18-character Salesforce Lead ID, e.g. 00Q5g000003aXyzEAE.

Sample Configuration

{
  "Resource": "lead",
  "Operation": "get",
  "InstanceUrl": "https://myorg.my.salesforce.com",
  "AccessToken": "{{credentials.salesforce.accessToken}}",
  "LeadId": "{{nodes.PreviousNode.leadId}}"
}

Validation Errors

Error CodeCondition
CFG_INVALIDNode settings could not be resolved.
CFG_MISSING_INSTANCEInstanceUrl is missing or empty.
CFG_MISSING_TOKENAccessToken is missing or empty.
VAL_MISSING_FIELDLeadId is missing or empty.
UNEXPECTED_ERRORUnexpected exception during execution.

Output

Success Port

Returns the full set of Lead fields from the Salesforce REST API. Key fields include:

FieldTypeDescription
Idstring18-character Salesforce Lead ID.
FirstNamestringLead first name.
LastNamestringLead last name.
CompanystringCompany name.
EmailstringEmail address.
PhonestringPhone number.
StatusstringCurrent lead status picklist value.
OwnerIdstringSalesforce User ID of the lead owner.
IsConvertedbooltrue if the lead has been converted.
CreatedDatestringISO 8601 creation timestamp.
LastModifiedDatestringISO 8601 last modified timestamp.

Error Port

FieldTypeDescription
errorCodestringMachine-readable error code.
messagestringHuman-readable description of the error.
resourcestringAlways lead.
operationstringAlways get.

Sample Output

{
  "Id": "00Q5g000003aXyzEAE",
  "FirstName": "Jane",
  "LastName": "Doe",
  "Company": "Acme Corp",
  "Email": "jane.doe@acme.com",
  "Phone": "+1-555-0100",
  "Title": "VP of Engineering",
  "Status": "Working - Contacted",
  "LeadSource": "Web",
  "IsConverted": false,
  "OwnerId": "0055g000007AbcDEF",
  "CreatedDate": "2026-05-20T08:30:00.000Z",
  "LastModifiedDate": "2026-05-25T14:10:00.000Z"
}

Expression Reference

ExpressionDescription
{{nodes.GetLead.Id}}Salesforce Lead ID.
{{nodes.GetLead.Email}}Lead's email address.
{{nodes.GetLead.Status}}Current lead status.
{{nodes.GetLead.OwnerId}}ID of the lead owner user.
{{nodes.GetLead.IsConverted}}Whether the lead has been converted.

Node Policies & GuardRails

PolicyDetail
Credential storageStore AccessToken in BizFirst Credentials Manager, not as plain text.
Token expiryAccess tokens expire. Configure automatic refresh via a Salesforce Connected App.
Not Found handlingIf the lead ID does not exist, the Salesforce API returns a 404. The node routes to the error port — always handle it.
Permission setsThe authenticated user must have read access to the Lead object in the target Salesforce org.
Sandbox testingTest against a sandbox before running in production.

Examples

Retrieve Lead for Email Personalization

After creating a lead, retrieve its full record to build a personalized follow-up email using all available fields.

{
  "Resource": "lead",
  "Operation": "get",
  "LeadId": "{{nodes.CreateLead.leadId}}"
}
// Then in email node:
// Subject: "Hi {{nodes.GetLead.FirstName}}, following up on your inquiry"
// Body: "Hi {{nodes.GetLead.FirstName}}, we saw your interest in ..."

Verify Lead Before Update

Use an IfCondition node after lead/get to confirm the lead exists and is not yet converted before triggering an update.

// IfCondition expression:
// {{nodes.GetLead.IsConverted}} == false AND {{nodes.GetLead.Status}} != "Closed - Converted"

Route by Lead Owner

Retrieve the lead and use the OwnerId field to look up the assigned sales rep's contact details before sending a Slack notification.

{
  "Resource": "lead",
  "Operation": "get",
  "LeadId": "{{trigger.leadId}}"
}
// Downstream: Slack node message to {{nodes.GetLead.OwnerId}} mapped to Slack user ID