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

Contact routes: create, get, list

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

Reference for Contact, one group of Contact routes.

Contact.create

Creates a Contact. Verb page.

Text
POST /{namespace}/contacts

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

Inputs

InputTypeRequiredDescription
emailemailThe primary email address.
phonestringThe primary phone number.
namestringThe name the Contact goes by.
organizationOrganizationA Contact works for one Organization, as this Startup knows it.
personPersonEach Contact is one Startup’s view of a Person shared across every Startup that knows them.

Returns

OutputTypeRequiredDescription
contactContactrequiredThe Contact.

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

Contact.get

Returns one Contact by id. Verb page.

Text
GET /{namespace}/contacts/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
contactContactrequiredThe Contact.

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/contacts/contact_WsrosCQi6J \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Contact",
  "$id": "https://api.sb/leaseline.app/contacts/contact_WsrosCQi6J",
  "contact": {
    "$id": "https://api.sb/leaseline.app/contacts/contact_WsrosCQi6J",
    "$type": "Contact",
    "email": "marcus@riversideproperty.com",
    "phone": "Example phone"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/contacts/contact_WsrosCQi6J",
    "up": "https://api.sb/leaseline.app/contacts"
  },
  "actions": {
    "enrich": "https://api.sb/leaseline.app/contacts/contact_WsrosCQi6J/enrich",
    "enroll": "https://api.sb/leaseline.app/contacts/contact_WsrosCQi6J/enroll",
    "merge": "https://api.sb/leaseline.app/contacts/contact_WsrosCQi6J/merge"
  }
}

Contact.list

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

Text
GET /{namespace}/contacts

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
contactslist of ContactrequiredOne page of Contacts.

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/contacts?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Contact",
  "contacts": [
    {
      "$id": "https://api.sb/leaseline.app/contacts/contact_WsrosCQi6J",
      "$type": "Contact",
      "email": "marcus@riversideproperty.com",
      "phone": "Example phone"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "contact_WsrosCQi6J"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/contacts?limit=20",
    "next": "https://api.sb/leaseline.app/contacts?after=contact_WsrosCQi6J"
  }
}

Contact

Previous

update, delete

Next