Team

The `Team` entity.

Definition

TypeScript

interface Team {
  id: string;
  organizationId: string;
  name: string;
  handle: string;
  createdBy: string | null;
  deletedAt: string | null;
  deletedBy: string | null;
  retentionTier: "short" | "medium" | "long" | "none" | null;
  createdAt: string;
  updatedAt: string;
}

Fields

Field	Type	Notes
`id`	`string`	`readonly` `required`
`organizationId`	`string`	`required` — Organization that owns the team. A team can be granted access to any workspace within its parent org via a permission row.
`name`	`string`	`required` — Human-readable team name.
`handle`	`string`	`required` — Org-unique team handle.
`createdBy`	`string \| null`	`required` — User who created the team (null if user has been deleted).
`deletedAt`	`string \| null`	`required` — Set when the team is soft-deleted; null while active.
`deletedBy`	`string \| null`	`required` — User who soft-deleted the team.
`retentionTier`	`"short" \| "medium" \| "long" \| "none" \| null`	`required` — Retention horizon after soft-delete (`short` ~7d, `medium` ~30d, `long` ~90d, `none` keeps forever). Null when active.
`createdAt`	`string`	`readonly` `required` — ISO-8601 timestamp of creation.
`updatedAt`	`string`	`readonly` `required` — ISO-8601 timestamp of the last modification.