Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Company settings API

9 operations. Generated from the OpenAPI document, so this page always matches the API. These take a company key, not a workspace key: send it as the bearer token, or pass it to new Shuffl in the SDK and shuffl login --company in the CLI.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

company.current

Read the company this key belongs to and the permissions it was granted

GET/api/v1/company

const result = await shuffl.company.current();
Request fields (none)

This operation takes no input.

Response object
  • catalog object[] required
    • access "read" | "write" required
    • description string required
    • granted boolean required
    • id "company.details" | "company.workspaces.list" | "company.members.list" | "company.emailDomains.list" | "company.slack.list" | "company.rename" | "company.workspaces.setDefault" | "company.members.remove" required
  • organizationId string required1 to 128 characters
  • permissions "company.details" | "company.workspaces.list" | "company.members.list" | "company.emailDomains.list" | "company.slack.list" | "company.rename" | "company.workspaces.setDefault" | "company.members.remove"[] required

company.details

Read the company name, logo and default workspace

GET/api/v1/company/details

const result = await shuffl.company.details();
Request fields (none)

This operation takes no input.

Response object
  • defaultTeamId string | null requiredThe workspace new email domain and single sign-on members join.
  • deleteAfter string (date-time) | null requiredWhen a deleted company is erased, or null.
  • deletionRequestedAt string (date-time) | null requiredWhen someone deleted the company, or null.
  • id string required1 to 128 characters
  • logo string | null required
  • name string required
  • role "owner" | "admin" | "member" requiredThe company role of the person who made the key.

company.workspaces.list

List the company's workspaces

GET/api/v1/company/workspaces.list

const result = await shuffl.company.workspaces.list();
Request fields (none)

This operation takes no input.

Response object[]
  • accessible boolean requiredWhether the person who made the key can open the workspace.
  • default boolean requiredWhether this is the default workspace.
  • id string required1 to 128 characters
  • logo string | null required
  • member boolean requiredWhether the person who made the key is a member of it.
  • name string required
  • status "active" | "paused" | "uninstalled" | "archived" | null required

company.members.list

List company members and their company roles

GET/api/v1/company/members.list

const result = await shuffl.company.members.list({});
Request fields (2)
  • cursor string optionalnextCursor from the previous page.. 1 to 1024 characters
  • limit integer optional1 to 100. Defaults to 25
Response object
  • items object[] required
    • email string required
    • id string requiredThe company membership id.. 1 to 128 characters
    • name string required
    • role "owner" | "admin" | "member" required
    • userId string requiredThe person’s user id. members.remove takes this.. 1 to 128 characters
  • nextCursor string | null required

company.emailDomains.list

List the company's email domains and their verification

GET/api/v1/company/emailDomains.list

const result = await shuffl.company.emailDomains.list();
Request fields (none)

This operation takes no input.

Response object[]
  • dnsRecord object | null requiredThe TXT record that proves the domain, until it is verified.
    • name string required
    • value string required
  • domain string required
  • id string required1 to 128 characters
  • verifiedAt string (date-time) | null required

company.slack.list

List the Slack workspaces connected to the company

GET/api/v1/company/slack.list

const result = await shuffl.company.slack.list();
Request fields (none)

This operation takes no input.

Response object[]
  • installation object | null requiredThe Slack connection, or null when the workspace has none.
    • enterpriseId string | null required
    • gridOrganizationId string | null required
    • revokedAt string (date-time) | null requiredWhen the connection stopped working, or null.
    • slackTeamId string required
  • teamId string required1 to 128 characters
  • teamName string required

company.rename

Rename the company

POST/api/v1/company/rename

const result = await shuffl.company.rename({
  "name": "<name>"
});
Request fields (1)
  • name string required1 to 100 characters
Response object
  • name string required

company.workspaces.setDefault

Choose the workspace new email domain and single sign-on members join

POST/api/v1/company/workspaces.setDefault

const result = await shuffl.company.workspaces.setDefault({
  "teamId": "<teamId>"
});
Request fields (1)
  • teamId string required1 to 128 characters
Response object
  • teamId string required1 to 128 characters

company.members.remove

Remove someone from the company (administrators only with an owner’s key)

POST/api/v1/company/members.remove

const result = await shuffl.company.members.remove({
  "userId": "<userId>"
});
Request fields (1)
  • userId string required1 to 128 characters
Response object
  • removed boolean required