Institution

Get all [institutions](/docs/api/institution).

Get All

Authorization

Fassport

Invalid Role

Unauthorized

Entity not found

Not Found

Internal Server Error

Find the [institution](/docs/api/institution) that matches the {institutionId} query parameter.

Get by id

institutionId

Get all the events for an [institution](/docs/api/institution). These events include things like [user](/docs/api/users) or [project](/docs/api/projects) changes, {billing} events, any other related updates.

Get events

Get all the documents for an [institution](/docs/api/institution). These [documents](/docs/api/documents) include anything the institution has access to read.

Get documents

Update an [institution](/docs/api/institution).

Update

name

Document

Find the [document](/docs/api/document) that matches the {documentId} query parameter.

documentId

Create a new [document](/docs/api/document).

Create

file

description

type

Update the [document](/docs/api/document) that matches the {documentId} query parameter.

Get all [events](/docs/api/event) for the [document](/docs/api/document) that matches the {documentId} query parameter.

Business

Get all [businesses](/docs/api/business).

Find the [business](/docs/api/business) that matches the {businessId} query parameter.

businessId

Get all [events](/docs/api/event) for the [business](/docs/api/business) that matches the {businessId} query parameter.

Create a new [business](/docs/api/business).

displayName

businessType

phone

line1

line2

city

state

country

website

netWorth

revenue

parent

Update the [business](/docs/api/business) that matches the {businessId} query parameter.

Delete the [business](/docs/api/business) that matches the {businessId} query parameter.

Delete

Add an owner to the [business](/docs/api/business) that matches the {businessId} query parameter.

Add Owner

Update the owner of the [business](/docs/api/business) that matches the {businessId} query parameter.

Update Owner

ownerId

Delete the owner of the [business](/docs/api/business) that matches the {businessId} query parameter.

Delete Owner

Application

Get all [applications](/docs/api/application).

Find the [application](/docs/api/application) that matches the {applicationId} query parameter.

applicationId

Update the [application](/docs/api/application) that matches the {applicationId} query parameter.

Get all [events](/docs/api/event) for the [application](/docs/api/application) that matches the {applicationId} query parameter.

Get all [documents](/docs/api/document) for the [application](/docs/api/application) that matches the {applicationId} query parameter.

Util

Health Check

Sucess

Lead

Find the [lead](/docs/api/lead) that matches the {leadId} query parameter.

leadId

Update the [lead](/docs/api/lead) that matches the {leadId} query parameter.

Update the image of the [lead](/docs/api/lead) that matches the {leadId} query parameter.

Update Image

Delete the [lead](/docs/api/lead) that matches the {leadId} query parameter.

Archive the [lead](/docs/api/lead) that matches the {leadId} query parameter.

Unarchive

Get the events of the [lead](/docs/api/lead) that matches the {leadId} query parameter.

Get Events

Get the documents of the [lead](/docs/api/lead) that matches the {leadId} query parameter.

Get Documents

Send the lead user invite to the [lead](/docs/api/lead) that matches the {leadId} query parameter.

Send Lead User Invite

Pipeline

Sales Pipeline

Find the [pipeline](/docs/api/pipeline) that matches the {pipelineId} query parameter.

pipelineId

Create a new [pipeline](/docs/api/pipeline).

Update an existing [pipeline](/docs/api/pipeline).

Delete an existing [pipeline](/docs/api/pipeline).

Archive an existing [pipeline](/docs/api/pipeline).

Unarchive an existing [pipeline](/docs/api/pipeline).

Create a new [stage](/docs/api/pipeline/stage) in an existing [pipeline](/docs/api/pipeline).

Create Stage

order

probability

leads

Update an existing [stage](/docs/api/pipeline/stage) in an existing [pipeline](/docs/api/pipeline).

Update Stage

stageId

Delete an existing [stage](/docs/api/pipeline/stage) in an existing [pipeline](/docs/api/pipeline).

Delete Stage

Add a [lead](/docs/api/lead) to an existing [stage](/docs/api/pipeline/stage) in an existing [pipeline](/docs/api/pipeline).

Add Lead to Stage

Remove a [lead](/docs/api/lead) from an existing [stage](/docs/api/pipeline/stage) in an existing [pipeline](/docs/api/pipeline).

Remove Lead from Stage

Campaign

Get all [marketing campaigns](/docs/api/campaign).

End of year marketing campaign targeting new investors

Q4 Growth Campaign

Find the [campaign](/docs/api/campaign) that matches the {campaignId} query parameter.