> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nextedy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Nextedy PLANNINGBOARD exposes several scripting and REST APIs that let administrators and integrators customize board behavior, extend card rendering, drive configuration programmatically, and query team data

Use the pages below to look up available objects, methods, and endpoints for each API surface.

<Columns cols={3}>
  <Card title="Scripting API" icon="file" href="/planningboard/reference/api/scripting-api">
    Entry point for board-level scripts. Covers the scripting lifecycle, execution context, and how to attach scripts to a Planningboard widget.
  </Card>

  <Card title="Item Script API" icon="file" href="/planningboard/reference/api/item-script-api">
    Per-card scripting hooks. Control card appearance, tooltip content, and custom actions on individual work item cards.
  </Card>

  <Card title="Config Script API" icon="file" href="/planningboard/reference/api/config-script-api">
    Programmatic access to widget configuration. Read and override widget parameters at runtime from within a board script.
  </Card>

  <Card title="Data Script API" icon="file" href="/planningboard/reference/api/data-script-api">
    Access to board data during script execution — Plans, work items, swimlane assignments, and capacity values.
  </Card>

  <Card title="REST API" icon="file" href="/planningboard/reference/api/rest-api">
    HTTP endpoints for querying and manipulating Planningboard data from external systems or automation scripts.
  </Card>

  <Card title="Teams Service API" icon="file" href="/planningboard/reference/api/teams-service-api">
    API surface for the Teams Service integration — query team membership, capacity, and resource assignments.
  </Card>
</Columns>

<Tip title="Scripting vs. REST">
  **Scripting APIs** (`Item Script API`, `Config Script API`, `Data Script API`) run inside the Planningboard server context and are configured through widget parameters. The **REST API** is called from outside Polarion over HTTP. The **Teams Service API** is relevant only when the Teams Service integration is enabled — see [Teams Service Properties](/planningboard/reference/configuration-properties/teams-properties) and [Scripting Properties](/planningboard/reference/configuration-properties/scripting-properties).
</Tip>

## API Relationships

<Frame>
  <img src="https://mintcdn.com/none-17b4493f/zUlmOSLBIQ0HyaAX/planningboard/diagrams/reference/api/index/diagram-1.svg?fit=max&auto=format&n=zUlmOSLBIQ0HyaAX&q=85&s=cce0bc64234ad00b611ef5fec13089f9" alt="Planningboard Widget branches into the Scripting API (Config, Data, and Item Script APIs, running server-side), the REST API (called over HTTP by external clients and automation), and the Teams Service API (calling the Teams Service backend when the integration is enabled)" width="900" height="530" data-path="planningboard/diagrams/reference/api/index/diagram-1.svg" />
</Frame>

<Accordion title="Sources">
  **KB Articles**

  * Planningboard: Customizable Statistics and Capacity Indicators

  **Source Code**

  * `PlanningBoardApiServlet.java`
  * `PlanningBoardViewServlet.java`
</Accordion>