Skip to content

Organization

An Organization is an outside party as one Startup knows it, keyed by its domain, such as an employer or a vendor.

Properties

PropertyTypeRequiredDescription
namestringrequiredThe name it trades under.
hostnamestringThe web domain that keys it.

Inherits from Party, which adds no properties of its own.

Object

JSON
{
  "$id": "https://api.sb/ledgerlark.com/organizations/organization_1",
  "$type": "Organization",
  "name": "LedgerLark",
  "hostname": "ledgerlark.com"
}

Relationships

  • An Organization has many Bills: a Bill is owed to one outside Organization, whose page lists every Bill the Startup owes it. bills, inverse owedTo.
  • An Organization has many Deals: each Deal has one buying Organization on the other side. deals, inverse courts.
  • An Organization’s people are many Contacts: a Contact works for one Organization, as this Startup knows it. people, inverse worksAt.
  • An Organization is reserved by one Partner: an Organization a Partner reserved before referring it, for the partner.reservationWindow Setting (90 days by default); outbound skips it. reservedBy, inverse reserves.
  • An Organization resolves to one Company: each Startup’s own view of an outside party resolves to the one legal entity behind it. resolvesTo, inverse knownAs.

Verbs

  1. createCreates an Organization.
    POST /{namespace}/organizationsdoOrganization.created
  2. getReturns one Organization by id.
    GET /{namespace}/organizations/{id}readNo Event
  3. listReturns Organizations, newest first, one page at a time.
    GET /{namespace}/organizationsreadNo Event
  4. updateChanges the given properties of an Organization.
    PATCH /{namespace}/organizations/{id}doOrganization.updated
  5. deleteDeletes an Organization; its history is kept.
    DELETE /{namespace}/organizations/{id}doOrganization.deleted
  6. mergeMerge joins a duplicate Organization into another, keeping every Contact, Deal and Event on the one that remains.
    POST /{namespace}/organizations/{organization}/mergedoOrganization.merged

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Organization.createYesYesYesNo
Organization.getYesYesYesYes
Organization.listYesYesYesYes
Organization.updateYesYesYesNo
Organization.deleteYesYesYesNo
Organization.mergeYesNoNoNo

Call it

Text
Merge my organization.

Example

To a recruiting-agency SaaS, the Organization keyed by northpeak-talent.com employs four Contacts and is the buyer on one Deal.