Leads

Entity›Activity›Activity.Lead

Leads capture inbound interest before it is qualified into a relation or a sales opportunity — a web-form submission, a downloaded whitepaper, or a captured contact from a campaign. Each lead records the prospect's contact details (FirstName, LastName, EmailAddress, PhoneNumber, CompanyName) alongside marketing attribution (Source, Medium, Campaign, Referrer, LandingPage) and qualification signals (DecisionMaker, Champion, DisqualificationReason).

Use the Activity_Lead endpoint to ingest and manage leads. Leads inherit all fields from Activity (subject, amount, financial totals) and add lead-specific contact, attribution, and qualification fields.

note

Replaces the deprecated Relationship-based Lead.

Endpoints

List Leads

Retrieve a paginated list of leads.

GET/v1/odata/Activity_Lead

Single Lead

Retrieve a single lead by its ID.

GET/v1/odata/Activity_Lead({id})

With expanded relations:

GET/v1/odata/Activity_Lead({id})?$expand=ActivityLead,LeadSource,Industry,Address

Create Lead

Create a new lead.

POST/v1/odata/Activity_Lead

Update Lead

Update an existing lead. Provide only the fields to update.

PUT/v1/odata/Activity_Lead({id})

Delete Lead

Delete a lead by ID.

DELETE/v1/odata/Activity_Lead({id})

Fields

Standard Fields (all entities)

Field	Type	Description
ID	Guid	Primary key (UUID)
_Type	String	Entity type discriminator (e.g., Activity.Lead)
_Name	String	Computed display name
SortIndex	Double	Sorting order
CreationDate	DateTimeOffset	Date the record was created
LastMutationDate	DateTimeOffset	Date of the last modification
IsActive	Boolean	Whether the record is active
IsClosed	Boolean	Whether the record is closed

Lead Fields

Field	Type	Description
FirstName	String	Prospect's first name
LastName	String	Prospect's last name
CompanyName	String	Prospect's company name
EmailAddress	String	Prospect's email address
PhoneNumber	String	Prospect's phone number
Website	String	Prospect's website
FunctionOnBusinessCard	String	Prospect's job title as shown on their business card
DecisionMaker	Boolean	Whether the prospect is a decision maker
Champion	Boolean	Whether the prospect is an internal champion
Campaign	String	Marketing campaign the lead came from
Referrer	String	Referring URL / source that sent the lead
LandingPage	String	Landing page the lead arrived on
DisqualificationReason	String	Reason the lead was disqualified

Inherited Fields (from Activity)

Field	Type	Description
Subject	String	Activity subject / title
Number	String	Auto-generated activity number (e.g., 2026-00001)
Amount	Double	Activity amount
Currency	String	Currency code (e.g., EUR)
IsVatIncluded	Boolean	Whether prices include VAT
DiscountPercentage	Double	Discount percentage
RelationDescription	String	Description of the linked relation
NumberOfProductLines	Double	Number of product lines
NumberOfOpenTasks	Double	Number of open tasks linked to this activity
NumberOfPlannedActions	Double	Number of planned actions
TotalSalesExcludingVAT	Double	Subtotal excluding VAT
TotalSalesIncludingVAT	Double	Total including VAT
VatAmount	Double	VAT amount
TotalMargin	Double	Total profit margin

Relationships

Relationship	Target Entity	Cardinality	Description
Phase	Datastore.Phase.ActivityLead	N:1	Lead phase / stage (nav property ActivityLead)
Address	Address	N:1	Lead address
Industry	Datastore.Industry	N:1	Prospect's industry
LeadCompanySize	Datastore.LeadCompanySize	N:1	Prospect's company size band
LeadSource	Datastore.LeadSource	N:1	Source the lead originated from
Medium	Datastore.Medium	N:1	Marketing medium
CampaignSource	Datastore.CampaignSource	N:1	Campaign source
Relationship	Relationship	N:1	Linked relation (customer/contact)
Contact	Relation.Person.Contact	N:1	Contact person
Responsible	Relationship.Person.Contact.Employee	N:1	Employee responsible for the lead
Involved	Involved	1:N	Involved parties
LinkedActivities	Activity	1:N	Linked activities
Activity	Activity	N:1	Parent activity

Expanding Relationships

GET/v1/odata/Activity_Lead({id})?$expand=ActivityLead

GET/v1/odata/Activity_Lead({id})?$expand=ActivityLead,LeadSource,Industry,Address

Navigating Relationships

GET/v1/odata/Activity_Lead({id})/LeadSource

GET/v1/odata/Activity_Lead({id})/Address

DELETE/v1/odata/Activity_Lead({id})/LeadSource/$ref

Filtering Examples

GET/v1/odata/Activity_Lead?$filter=contains(CompanyName, '{CompanyName}')&$top={top}

GET/v1/odata/Activity_Lead?$filter=EmailAddress eq '{EmailAddress}'&$top={top}

GET/v1/odata/Activity_Lead?$filter=DecisionMaker eq {DecisionMaker}&$top={top}

GET/v1/odata/Activity_Lead?$filter=contains(LastName, '{LastName}')&$top={top}

GET/v1/odata/Activity_Lead?$filter=CreationDate gt {CreationDate}&$top={top}

GET/v1/odata/Activity_Lead?$filter=IsClosed eq {IsClosed}&$top={top}