Skip to main content

Prospects

Entity›Relationship›CommercialRelationship.Prospect

A Prospect is a qualified lead in active negotiation — typically the stage where pricing discussions, demos, and procurement begin. Prospects sit between Hot Prospects and Customers in the sales funnel.

The TribeCRM commercial funnel is: Suspect → Lead → HotProspect → Prospect → Customer.

Two variants
  • Organisation Prospect — Relationship_Organization_CommercialRelationship_Prospect — when the prospect is a company.
  • Person Prospect — Relationship_Person_CommercialRelationship_Prospect — when the prospect 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 Prospects​

Retrieve a paginated list of prospects.

Organisation (B2B)

GET/v1/odata/Relationship_Organization_CommercialRelationship_Prospect

Person (B2C)

GET/v1/odata/Relationship_Person_CommercialRelationship_Prospect

Single Prospect​

Retrieve a single prospect by its ID.

Organisation (B2B)

GET/v1/odata/Relationship_Organization_CommercialRelationship_Prospect({id})
GET/v1/odata/Relationship_Organization_CommercialRelationship_Prospect({id})?$expand=Organization,Relation

Person (B2C)

GET/v1/odata/Relationship_Person_CommercialRelationship_Prospect({id})
GET/v1/odata/Relationship_Person_CommercialRelationship_Prospect({id})?$expand=Person,Relation

Create Prospect with a New Relation​

Create a prospect relationship and its underlying Organisation or Person in one call.

Organisation (B2B)

POST/v1/odata/Relationship_Organization_CommercialRelationship_Prospect

Person (B2C)

POST/v1/odata/Relationship_Person_CommercialRelationship_Prospect
  • Relation.ID — The parent Relation (typically your own organisation).
  • Organization / Person — The child Relation fields (created automatically). For Person, LastName is mandatory.

Create Prospect from an Existing Relation​

Link an existing Organisation or Person as a prospect.

Organisation (B2B)

POST/v1/odata/Relationship_Organization_CommercialRelationship_Prospect

Person (B2C)

POST/v1/odata/Relationship_Person_CommercialRelationship_Prospect

Update Prospect​

Update an existing prospect relationship. Provide only the fields to update.

Organisation (B2B)

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

Person (B2C)

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

Convert Prospect to Customer​

Promote a Prospect to a Customer by changing its _Type. All linked activities, notes, and history are preserved.

Organisation (B2B)

POST/v1/odata/Relationship_Organization_CommercialRelationship_Prospect

Person (B2C)

POST/v1/odata/Relationship_Person_CommercialRelationship_Prospect

Use the Relationship ID, not any of the Relation IDs.

note

Type conversion only works within the same Relation type: an Organisation Prospect can become an Organisation Customer, a Person Prospect can become a Person Customer. You cannot cross-convert between Organisation and Person variants.

Delete Prospect​

Delete a prospect relationship by ID. This removes the prospect role but does not delete the underlying Organisation or Person.

Organisation (B2B)

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

Person (B2C)

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

Fields​

Standard Fields (all entities)​

FieldTypeDescription
IDGuidPrimary key (UUID)
_TypeStringEntity type discriminator (Relationship.Organization.CommercialRelationship.Prospect or Relationship.Person.CommercialRelationship.Prospect)
_NameStringComputed display name
SortIndexDoubleSorting order
CreationDateDateTimeOffsetDate the record was created
LastMutationDateDateTimeOffsetDate of the last modification
IsActiveBooleanWhether the record is active
IsClosedBooleanWhether the record is closed

Prospect Fields​

FieldTypeDescription
NameStringProspect display name

Relationships​

RelationshipTarget EntityCardinalityDescription
RelationRelationN:1Parent relation (your organisation)
OrganizationRelation.OrganizationN:1B2B only: the prospect organisation
PersonRelation.PersonN:1B2C only: the prospect person
StatusDatastoreN:1Prospect status

Expanding Relationships​

GET/v1/odata/Relationship_Organization_CommercialRelationship_Prospect({id})?$expand=Organization
GET/v1/odata/Relationship_Person_CommercialRelationship_Prospect({id})?$expand=Person
GET/v1/odata/Relationship_Organization_CommercialRelationship_Prospect({id})/Relation

Filtering Examples​

The same $filter syntax applies to both Organisation and Person variants — substitute the entity URL accordingly.

GET/v1/odata/Relationship_Organization_CommercialRelationship_Prospect?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Relationship_Person_CommercialRelationship_Prospect?$filter=CreationDate gt {CreationDate}&$top={top}
GET/v1/odata/Relationship_Organization_CommercialRelationship_Prospect?$filter=IsClosed eq {IsClosed}&$top={top}

Custom Query​

Build your own OData query against Relationship_Organization_CommercialRelationship_Prospect. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.

GET/v1/odata/Relationship_Organization_CommercialRelationship_Prospect?$top=10