Get team information | Sample

2 parameters

tokenstringrequired

Authentication token with the `team:read` scope.

teamstringoptional

Team to retrieve; defaults to the current team when omitted and is limited to teams visible to the authenticated token through external shared channels.

2 status codes

200Returns an object containing `ok` set to true and a `team` object with fields including its `id`, `name`, `domain`, `email_domain`, and `icon`.

okbooleanrequired

Allowed:true

teamobjectrequired

defaultReturns an error object with `ok` set to false and an `error` value describing why team information could not be retrieved.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissioninvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_typemissing_post_typeteam_added_to_org

okbooleanrequired

Allowed:false

Error handling

Supply token with the team:read scope. If provided, team must identify a team that the authenticated token is allowed to see through external shared channels.

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.teamInfo.list({
  token: "sk_live_4eC39Hq",
  team: "example",
});

{
  "ok": true,
  "team": {
    "domain": "example",
    "email_domain": "example.com",
    "enterprise_id": "E1234A12AB",
    "enterprise_name": "Umbrella Corporation",
    "icon": {
      "image_102": "https://...",
      "image_132": "https://...",
      "image_34": "https://...",
      "image_44": "https://...",
      "image_68": "https://...",
      "image_88": "https://...",
      "image_default": true
    },
    "id": "T12345",
    "name": "My Team"
  }
}

Request

Response

Errors