Leads (Relationship) - DEPRECATED
This Relationship-based Lead is deprecated. New integrations should use the Lead activity (Activity_Lead) instead.
A Lead is a qualified contact in your sales funnel — someone (or some company) that has been verified as a potential customer worth pursuing. Leads come after raw Suspects are qualified, and ahead of Hot Prospects and Prospects once engagement deepens.
The TribeCRM commercial funnel is: Suspect → Lead → HotProspect → Prospect → Customer.
- Organisation Lead —
Relationship_Organization_CommercialRelationship_Lead— when the lead is a company. - Person Lead —
Relationship_Person_CommercialRelationship_Lead— when the lead is an individual (B2C).
Both share the same fields and lifecycle; the only difference is which Relation subtype is linked (Organization vs Person).
Endpoints
List Leads
Retrieve a paginated list of leads.
Organisation (B2B)
/v1/odata/Relationship_Organization_CommercialRelationship_LeadPerson (B2C)
/v1/odata/Relationship_Person_CommercialRelationship_LeadSingle Lead
Retrieve a single lead by its ID.
Organisation (B2B)
/v1/odata/Relationship_Organization_CommercialRelationship_Lead({id})/v1/odata/Relationship_Organization_CommercialRelationship_Lead({id})?$expand=Organization,RelationPerson (B2C)
/v1/odata/Relationship_Person_CommercialRelationship_Lead({id})/v1/odata/Relationship_Person_CommercialRelationship_Lead({id})?$expand=Person,RelationCreate Lead with a New Relation
Create a lead relationship and its underlying Organisation or Person in one call.
Organisation (B2B)
/v1/odata/Relationship_Organization_CommercialRelationship_LeadPerson (B2C)
/v1/odata/Relationship_Person_CommercialRelationship_LeadRelation.ID— The parent Relation (typically your own organisation).Organization/Person— The child Relation fields (created automatically). For Person,LastNameis mandatory.
Create Lead from an Existing Relation
Link an existing Organisation or Person as a lead.
Organisation (B2B)
/v1/odata/Relationship_Organization_CommercialRelationship_LeadPerson (B2C)
/v1/odata/Relationship_Person_CommercialRelationship_LeadUpdate Lead
Update an existing lead relationship. Provide only the fields to update.
Organisation (B2B)
/v1/odata/Relationship_Organization_CommercialRelationship_Lead({id})Person (B2C)
/v1/odata/Relationship_Person_CommercialRelationship_Lead({id})Convert Lead to next funnel stage
Promote a Lead to a Hot Prospect, Prospect, or Customer by changing its _Type. All linked activities, notes, and history are preserved.
Organisation (B2B)
/v1/odata/Relationship_Organization_CommercialRelationship_LeadPerson (B2C)
/v1/odata/Relationship_Person_CommercialRelationship_LeadUse the Relationship ID, not any of the Relation IDs.
Type conversion only works within the same Relation type: an Organisation Lead can become an Organisation Hot Prospect / Prospect / Customer, a Person Lead can become a Person Hot Prospect / Prospect / Customer. You cannot cross-convert between Organisation and Person variants.
Delete Lead
Delete a lead relationship by ID. This removes the lead role but does not delete the underlying Organisation or Person.
Organisation (B2B)
/v1/odata/Relationship_Organization_CommercialRelationship_Lead({id})Person (B2C)
/v1/odata/Relationship_Person_CommercialRelationship_Lead({id})Fields
Standard Fields (all entities)
| Field | Type | Description |
|---|---|---|
ID | Guid | Primary key (UUID) |
_Type | String | Entity type discriminator (Relationship.Organization.CommercialRelationship.Lead or Relationship.Person.CommercialRelationship.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 |
|---|---|---|
Name | String | Lead display name |
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| Relation | Relation | N:1 | Parent relation (your organisation) |
| Organization | Relation.Organization | N:1 | B2B only: the lead organisation |
| Person | Relation.Person | N:1 | B2C only: the lead person |
| Status | Datastore | N:1 | Lead status |
Expanding Relationships
/v1/odata/Relationship_Organization_CommercialRelationship_Lead({id})?$expand=Organization/v1/odata/Relationship_Person_CommercialRelationship_Lead({id})?$expand=PersonNavigating Relationships
/v1/odata/Relationship_Organization_CommercialRelationship_Lead({id})/RelationFiltering Examples
The same $filter syntax applies to both Organisation and Person variants — substitute the entity URL accordingly.
/v1/odata/Relationship_Organization_CommercialRelationship_Lead?$filter=contains(Name, '{Name}')&$top={top}/v1/odata/Relationship_Organization_CommercialRelationship_Lead?$filter=ID eq {ID}-43a4-483b-82e1-4ccf8bd1526c&$top={top}/v1/odata/Relationship_Person_CommercialRelationship_Lead?$filter=CreationDate gt {CreationDate}&$top={top}/v1/odata/Relationship_Organization_CommercialRelationship_Lead?$filter=IsClosed eq {IsClosed}&$top={top}Custom Query
Build any OData query yourself. The endpoint below is prefilled with a real-world example — a name search across the linked Person, with a nested $expand that pulls the person (plus their address, country, and picture), the parent relation, and the account manager.
Open Run and edit the whole request inline — including the entity set (e.g. swap Relationship_Person_… for Relationship_Organization_…). Change the $filter, add $select, adjust $top, or extend the $expand. Type $ for suggestions; use ↺ Reset to restore this example.
/v1/odata/Relationship_Person_CommercialRelationship_Lead?$filter=contains(Person/FirstName, 'John') and contains(Person/LastName, 'Doe')&$top=10&$expand=Person($expand=Address($expand=Country),Picture),Relation($select=_Name),AccountManager($select=Name)