Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductDomains and accessMember Directory

Member Directory routes: create, get, list

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

Reference for Member Directory, one group of Member Directory routes.

MemberDirectory.create

Creates a Member Directory. Verb page.

Text
POST /{namespace}/member-directories

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

Inputs

InputTypeRequiredDescription
groupRolesjsonWhich directory group fills which Role in the Tenant.
lastChangeAtdatetimeWhen the Customer’s directory last pushed a change.
tenantTenantA Member Directory fills and empties Roles in one Tenant as people join and leave the Customer.

Returns

OutputTypeRequiredDescription
memberDirectoryMember DirectoryrequiredThe Member Directory.

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/member-directories \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"groupRoles":{}}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "memberDirectory": {
    "$id": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
    "$type": "MemberDirectory",
    "state": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "MemberDirectory.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

MemberDirectory.get

Returns one Member Directory by id. Verb page.

Text
GET /{namespace}/member-directories/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
memberDirectoryMember DirectoryrequiredThe Member Directory.

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/member-directories/directory_qZldlwGLVN \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "MemberDirectory",
  "$id": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
  "memberDirectory": {
    "$id": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
    "$type": "MemberDirectory",
    "state": "draft"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
    "up": "https://api.sb/leaseline.app/member-directories"
  },
  "actions": {
    "deactivate": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN/deactivate",
    "deprovision": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN/deprovision"
  }
}

MemberDirectory.list

Returns Member Directories, newest first, one page at a time. Verb page.

Text
GET /{namespace}/member-directories

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
memberDirectorieslist of Member DirectoryrequiredOne page of Member Directories.

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/member-directories?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "MemberDirectory",
  "memberDirectories": [
    {
      "$id": "https://api.sb/leaseline.app/member-directories/directory_qZldlwGLVN",
      "$type": "MemberDirectory",
      "state": "draft"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "directory_qZldlwGLVN"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/member-directories?limit=20",
    "next": "https://api.sb/leaseline.app/member-directories?after=directory_qZldlwGLVN"
  }
}

Member Directory

Previous

update

Next