Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthProspect

Prospect routes: create, get, list

The Prospect Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Prospect, one group of Prospect routes.

Prospect.create

Creates a Prospect. Verb page.

Text
POST /{namespace}/prospects

Body, as JSON: the inputs. Emits Prospect.created.

Inputs

InputTypeRequiredDescription
foundInstringrequiredWhere the Startup found them.
basisstringrequiredThe basis on record for contacting them.
acquisitionAcquisitionA Prospect’s Acquisition names the outbound Play and Mailbox that first reached it.

Returns

OutputTypeRequiredDescription
prospectProspectrequiredThe Prospect.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/prospects \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"foundIn":"Example found in","basis":"Example basis"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "prospect": {
    "$id": "https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R",
    "$type": "Prospect",
    "foundIn": "Example found in",
    "basis": "Example basis"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Prospect.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Prospect.get

Returns one Prospect by id. Verb page.

Text
GET /{namespace}/prospects/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Prospect.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
prospectProspectrequiredThe Prospect.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Prospect",
  "$id": "https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R",
  "prospect": {
    "$id": "https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R",
    "$type": "Prospect",
    "foundIn": "Example found in",
    "basis": "Example basis"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R",
    "up": "https://api.sb/leaseline.app/prospects"
  },
  "actions": {
    "engage": "https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R/engage"
  }
}

Prospect.list

Returns Prospects, newest first, one page at a time. Verb page.

Text
GET /{namespace}/prospects

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
prospectslist of ProspectrequiredOne page of Prospects.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/prospects?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Prospect",
  "prospects": [
    {
      "$id": "https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R",
      "$type": "Prospect",
      "foundIn": "Example found in",
      "basis": "Example basis"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "prospect_S8bqJCxC9R"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/prospects?limit=20",
    "next": "https://api.sb/leaseline.app/prospects?after=prospect_S8bqJCxC9R"
  }
}

Prospect

Previous

update, delete

Next