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

Lead routes: create, get, list

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

Reference for Lead, one group of Lead routes.

Lead.create

Creates a Lead. Verb page.

Text
POST /{namespace}/leads

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

Inputs

InputTypeRequiredDescription
emailemailThe primary email address.
phonestringThe primary phone number.
namestringThe name the Contact goes by.
interesttextWhat the Lead asked for.
ownerWorkerThe Worker who answers it.
waitlistWaitlistLeads wait on a Waitlist in the order its Setting ranks them.
formFormEach Form submission creates a Lead.
acquisitionAcquisitionEach Lead keeps the Acquisition that first brought it, through either door: a Visit or an outbound reply.

Returns

OutputTypeRequiredDescription
leadLeadrequiredThe Lead.

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/leads \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"dana@leaseline.app"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "lead": {
    "$id": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
    "$type": "Lead",
    "status": "new"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Lead.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Lead.get

Returns one Lead by id. Verb page.

Text
GET /{namespace}/leads/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
leadLeadrequiredThe Lead.

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/leads/lead_Kz1R9fhqzZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Lead",
  "$id": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
  "lead": {
    "$id": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
    "$type": "Lead",
    "status": "new"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
    "up": "https://api.sb/leaseline.app/leads"
  },
  "actions": {
    "assign": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ/assign",
    "convert": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ/convert",
    "disqualify": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ/disqualify"
  }
}

Lead.list

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

Text
GET /{namespace}/leads

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
leadslist of LeadrequiredOne page of Leads.

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/leads?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Lead",
  "leads": [
    {
      "$id": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
      "$type": "Lead",
      "status": "new"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "lead_Kz1R9fhqzZ"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/leads?limit=20",
    "next": "https://api.sb/leaseline.app/leads?after=lead_Kz1R9fhqzZ"
  }
}

Lead

Previous

update, delete

Next