Get workspace settings information | Sample

2 parameters

team_idstringrequired

The identifier of the workspace whose settings information to retrieve.

tokenstringrequired

Authentication token with the `admin.teams:read` scope.

2 status codes

200Returns a successful response containing the workspace settings information with `ok` set to true.

okbooleanrequired

Allowed:true

defaultReturns the standard failure response with `ok` set to false.

okbooleanrequired

Allowed:false

Error handling

team_id must identify the workspace whose settings you want to retrieve. token must carry the admin.teams:read scope.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.adminTeamsSettingsInfo.list({ teamId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "ok": true,
  "team": {
    "default_channels": "array",
    "domain": "string",
    "email_domain": "string",
    "enterprise_id": "string",
    "enterprise_name": "string",
    "icon": "array",
    "id": "string",
    "name": "string"
  }
}

Request

Response

Errors