---
title: "Get the team board index"
method: GET
path: "/api/v2/orgs/{orgId}/teams/{teamId}/index"
tags: ["Teams"]
---

# Get the team board index

`GET /api/v2/orgs/{orgId}/teams/{teamId}/index`

## Request

- Base URL: `https://davinci-app.com`
- URL: `https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/index`
- Auth: HTTP bearer

Returns team metadata, workflow statuses, sprints, board cards, and viewer
capabilities. API-key requests default to 100 cards and may request up to
500; browser requests remain unbounded when pagination is omitted.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Composite team board index.

- TeamIndex
  - `team` AgileTeam, required
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable, required
    - `status` string, required: Team lifecycle status; `active` is the database default.
    - `created_at` string, date-time, nullable, required
    - `updated_at` string, date-time, nullable, required
    - `organization_id` string, uuid, required
    - `visibility` 'private' | 'internal', required
  - `workflowStatuses` TeamWorkflowStatus[], required
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable, required
    - `position` string, required
    - `color` string, required
    - `status` string, required: Workflow-status lifecycle flag; `active` is the database default.
    - `transition_state` 'not_started' | 'started' | 'closed', required
    - `closeMode` 'off' | 'manual' | 'automatic' | 'add_mover_to_assignees', required: Automatic close-on-entry behavior for a workflow status. The bulk close action is available for every status. `off` leaves card state unchanged on entry, while `automatic` closes open cards on entry. `manual` is a deprecated legacy value with the same entry behavior as `off`. `add_mover_to_assignees` is a deprecated write alias that stores `closeMode=off` with `assignMoverOnEntry=true`; reads never return that alias.
    - `assignMoverOnEntry` boolean, required: When true, entering this status adds the authenticated mover as an assignee without removing existing assignees. Combines with any `closeMode`.
    - `requiredCardFields` CardRequiredField[], required
    - `team_id` string, uuid, required
  - `sprints` AgileTeamSprint[], required
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable, required
    - `status` 'planned' | 'active' | 'completed', required
    - `created_at` string, date-time, nullable, required
    - `start_date` string, date-time, nullable, required
    - `end_date` string, date-time, nullable, required
    - `team_id` string, uuid, required
  - `cards` TeamBoardCardWithAssignees[], required
    - `<<` unknown
  - `meta` OffsetPageMeta
    - `limit` integer, required
    - `offset` integer, required
    - `hasMore` boolean, required
    - `total` integer
  - `viewerCapabilities` TeamViewerCapabilities, required
    - `hasHierarchyOverride` boolean, required
    - `canReadTeam` boolean, required
    - `canManageTeam` boolean, required
    - `canDeleteTeam` boolean, required
    - `canReadMembers` boolean, required
    - `canInviteMembers` boolean, required
    - `canRemoveMembers` boolean, required
    - `canUpdateMemberRoles` boolean, required
    - `canAddProjects` boolean, required
    - `canRemoveProjects` boolean, required
    - `canCreateSprint` boolean, required
    - `canReadSprints` boolean, required
    - `canManageSprint` boolean, required
    - `canDeleteSprint` boolean, required
    - `canManageBoardCards` boolean, required
    - `canReadAnalysis` boolean, required

## Other responses

- `400`: Malformed request parameters or body. Agile requests may return `INVALID_PAGINATION` or `INVALID_IDEMPOTENCY_KEY`.
- `401`: No credential was supplied, or the supplied credential is malformed, expired, or revoked. A credential that is present but unusable is never downgraded to an anonymous request.
- `403`: Authenticated but not authorized. Either the acting user lacks the required resource permission, the key's scope ceiling excludes it, or the endpoint rejects this credential type (`CREDENTIAL_NOT_PERMITTED`).
- `404`: The resource does not exist in the parent named by the path, or is hidden from the caller. Absence and privacy denial are deliberately indistinguishable so project, organization, and private-team existence cannot be probed.
- `429`: Request rate exceeded, either globally or for this key.
- `500`: Unexpected server error.

## Changes

- **2026-09-24** (v2) `4b520e771e08`: 1 warning, 3 info
  - added the new `add_mover_to_assignees` enum value to the `workflowStatuses/items/closeMode` response property for the response status `200`
  - added the required property `viewerCapabilities/hasHierarchyOverride` to the response with the `200` status
  - added the required property `workflowStatuses/items/assignMoverOnEntry` to the response with the `200` status
  - added the required property `workflowStatuses/items/requiredCardFields` to the response with the `200` status
- **2026-09-15** (v2) `aa52eb4e8fd3`: 1 breaking, 1 info
  - removed the required property `viewerPermissions` from the response with the `200` status
  - added the required property `viewerCapabilities` to the response with the `200` status
- **2026-09-15** (v2) `67c8b8616dbb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/celedon-solutions/apis/davinci-public-api/changes/api/v2/orgs/:orgId/teams/:teamId/index/get.md)

---

[API](https://skmtc.dev/celedon-solutions/apis/davinci-public-api.md) - [All operations](https://skmtc.dev/celedon-solutions/apis/davinci-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/celedon-solutions/apis/davinci-public-api/revisions/279218ca2e8d?raw)