Get one program

Retrieves detailed information about a specific program including its metadata, managers, custom properties,
associations, phases, analytics settings, and Slack integrations. Optionally includes associated tasks and
content pages for comprehensive program views.

Key Features:

  • Retrieves complete program details including all metadata and relationships
  • Optionally includes associated tasks (works) for full program context
  • Optionally includes page data for content associations
  • Supports configurable depth for associated entity data retrieval
  • Returns custom properties, phases, and analytics configuration
  • Includes Slack integration details if configured

Authorization Logic:

  1. User must have a valid JWT token with viewing or management scopes
  2. Token can be for either user or system operations (tenant token without user ID)
  3. User must have permission to view the specific program

Usage Example:

Retrieve a program to display in the UI, including all associated tasks for program management dashboards,
or fetch program details for reporting and analytics purposes.

Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

string
required

The unique identifier of the program to retrieve. Must be a valid program ID within the specified space.

Query Params
int32

Optional depth level for retrieving associated entity data (tasks, content, requests). Higher values return more
nested association details.

boolean

Optional flag to include associated tasks/works in the response. Set to true to retrieve all tasks under this
program.

boolean
Defaults to false

Optional flag to include page model data for content associations. Set to true to retrieve page details for associated content.

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json