# AirSaas Documentation > Documentation for AirSaas ## Guides - [Documentation](https://developers.airsaas.io/docs.md): AirSaas documentation ## API Reference - [Quotas](https://developers.airsaas.io/reference/quotas.md) - [Get profile](https://developers.airsaas.io/reference/profile_retrieve.md): Get profile information about the authorization token used. Includes information about the corresponding user account and the corresponding workspace. The `email` field is only included when authenticating with an API key or when the OAuth token has the `email` scope. - [List all decisions](https://developers.airsaas.io/reference/decisions_list.md): Returns a paginated list of all **Decisions** of the workspace, accessible by the authorization token used. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `decision_maker` * `project` * `workspace_program` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve a decision](https://developers.airsaas.io/reference/decisions_retrieve.md): Retrieves a **Decision** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `decision_maker` * `project` * `workspace_program` Read more in our section about [expandable properties](ref:expandable-properties). - [Create a decision](https://developers.airsaas.io/reference/decisions_create.md): Creates a **Decision** in the workspace. Exactly one of `project` or `workspace_program` must be provided. The `owner` is set automatically from the authorization token. If `status` is omitted, the first active workspace decision status is used. - [Update a decision](https://developers.airsaas.io/reference/decisions_partial_update.md): Partially updates a **Decision**. `project` and `workspace_program` cannot be changed after creation. Fields the caller is not allowed to edit are silently ignored. - [Update decision status](https://developers.airsaas.io/reference/decisions_update_status_create.md): Updates the status of the given **Decision**. A message **must** be provided to help other workspace users to understand why the status has changed. - [Get last status update](https://developers.airsaas.io/reference/decisions_last_status_update_retrieve.md): Returns the last status update for the decision, including the user who made the change, the old and new values, and any comment provided. - [List all program decisions](https://developers.airsaas.io/reference/programs_decisions_list.md): Returns a paginated list of all **Decisions** linked to the given **Program**, with the same visibility rules as the workspace decisions list. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `decision_maker` * `project` * `workspace_program` Read more in our section about [expandable properties](ref:expandable-properties). ### OAuth2 For **OAuth2** bearer tokens, **GET** requires all of these read scopes: `program:read`, `decision:read` (resources: `program`, `decision`). Alternatively, the umbrella scope `all:read` (GET) or `all:write` (write methods) satisfies any endpoint. ### Note If the parent resource in the URL path cannot be accessed or does not exist, the response is **200** with an empty `results` list. - [List all project decisions](https://developers.airsaas.io/reference/projects_decisions_list.md): Returns a paginated list of all **Decisions** linked to the given **Project**, with the same visibility rules as the workspace decisions list. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `decision_maker` * `project` * `workspace_program` Read more in our section about [expandable properties](ref:expandable-properties). - [List decision feed](https://developers.airsaas.io/reference/decisions_feed_list.md): Returns a cursor-based feed for a **Decision**. Feed items are sorted by `created_at` descending. Use `before_timestamp` to request older items. The response window is fixed to 10 items. - [Create a note on a decision](https://developers.airsaas.io/reference/decisions_notes_create.md): Creates a note on the given **Decision**. Provide `text` as Markdown or Quill delta JSON. Returns the created note as a feed item. - [List all decision custom attributes](https://developers.airsaas.io/reference/decision_custom_attributes_list.md): Returns a paginated list of all **decision custom attributes** in the workspace. - [Retrieve a decision custom attribute](https://developers.airsaas.io/reference/decision_custom_attributes_retrieve.md): Retrieves a **Decision Custom Attribute** using the provided ID. - [List all decision statuses](https://developers.airsaas.io/reference/decisions_statuses_list.md): Returns a paginated list of all **Decision Statuses** of the workspace. Those status codes can then be used to [update a decision status](ref:decisions_update_status_create) for example. - [Retrieve a decision status](https://developers.airsaas.io/reference/decisions_statuses_retrieve.md): Retrieves a **Decision Status** using the provided ID. - [List all decision status groups](https://developers.airsaas.io/reference/decisions_status_groups_list.md): Returns a paginated list of all active **Decision status groups**. - [Retrieve a decision status group](https://developers.airsaas.io/reference/decisions_status_groups_retrieve.md): Retrieves a **Decision status group** using the provided ID. - [List all decision importances](https://developers.airsaas.io/reference/decisions_importances_list.md): Returns a paginated list of all **decision importances** in the workspace. - [Retrieve a decision importance](https://developers.airsaas.io/reference/decisions_importances_retrieve.md): Retrieves a **Decision Importance** using the provided ID. - [List decision status history](https://developers.airsaas.io/reference/decisions_status_history_list.md): Returns a paginated list of status updates for the **Decision**, sorted by most recent first. - [List all projects](https://developers.airsaas.io/reference/projects_list.md): Returns a paginated list of all **Projects** of the workspace, accessible by the authorization token used. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `program` * `goals` * `teams` * `requesting_team` Read more in our section about [expandable properties](ref:expandable-properties). - [Create a project](https://developers.airsaas.io/reference/projects_create.md): Create a **Project**. Status restriction: you can only create a project using a scope status. If you omit the status field, the first scope status will be used by default. - [List all project efforts](https://developers.airsaas.io/reference/projects_efforts_list.md): Returns a paginated list of all **team efforts** for the given project. Each returned element is an association of a team with its initial and consumed efforts in man-days. - [List all project members](https://developers.airsaas.io/reference/projects_members_list.md): Returns a paginated list of all **Members** of the given project. Each member returned is a combination of a **User** and a **Project Role**. Users can appear several times in the results, with different roles. - [Assign a member to a project](https://developers.airsaas.io/reference/projects_members_create.md): Assigns a **User** to the given **Project** with a specific **Project Role**. A user can appear several times as a member of the same project, with different roles. - [List all project milestones](https://developers.airsaas.io/reference/projects_milestones_list.md): Returns a paginated list of all **Milestones** of the given project. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `team` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve a project milestone](https://developers.airsaas.io/reference/projects_milestones_retrieve.md): Retrieves a **Project Milestone** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `team` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve a project](https://developers.airsaas.io/reference/projects_retrieve.md): Retrieves a **Project** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `program` * `goals` * `teams` * `requesting_team` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve extended project](https://developers.airsaas.io/reference/projects_extended_retrieve.md): Returns extended project data: all standard fields with owner, goals, teams, and requesting_team expanded, plus last weather/status updates, linked-object metrics, full program, and all pinned feed items. - [Update a project](https://developers.airsaas.io/reference/projects_partial_update.md): Update **Project** properties. - [Update project efforts](https://developers.airsaas.io/reference/projects_update_effort_create.md): Updates the efforts of the given **Project** for a given team. Providing the team Id, you can update the initial effort (`effort`) and the consumed effort (`effort_used`). In case the project is managing yearly efforts, the current fiscal year's effort will be updated. - [Update project status](https://developers.airsaas.io/reference/projects_update_status_create.md): Updates the status of the given **Project**. A message **must** be provided to help other workspace users to understand why the status has changed. - [List project feed](https://developers.airsaas.io/reference/projects_feed_list.md): Returns a cursor-based feed for a **Project**. Feed items are sorted by `created_at` descending. Use `before_timestamp` to request older items. The response window is fixed to 10 items. - [Get last status update](https://developers.airsaas.io/reference/projects_last_status_update_retrieve.md): Returns the last status update for the project, including the user who made the change, the old and new values, and any comment provided. - [Get last weather update](https://developers.airsaas.io/reference/projects_last_weather_update_retrieve.md): Returns the last weather (mood) update for the project, including the user who made the change, the old and new values, and any comment provided. - [Update project weather](https://developers.airsaas.io/reference/projects_update_weather_create.md): Updates the weather (mood) of the given **Project**. A message **must** be provided to help other workspace users understand why the mood has changed. - [List project weather history](https://developers.airsaas.io/reference/projects_weather_history_list.md): Returns a paginated list of weather (mood) updates for the project, sorted by most recent first. - [Update project importance](https://developers.airsaas.io/reference/projects_update_importance_create.md): Updates the importance of the given **Project**. A message **must** be provided to help other workspace users understand why the importance has changed. - [Update project risk](https://developers.airsaas.io/reference/projects_update_risk_create.md): Updates the risk of the given **Project**. A message **must** be provided to help other workspace users understand why the risk has changed. - [Archive a project](https://developers.airsaas.io/reference/projects_archive_create.md): Archives the given **Project**. All child objects (milestones, decisions, attention points, meeting reports) will also be archived. If the project is already archived, the response `status` will be `already_archived`. - [Unarchive a project](https://developers.airsaas.io/reference/projects_unarchive_create.md): Unarchives (restores) the given **Project**. Child objects that were archived together with this project will also be restored. If the project is already active, the response `status` will be `already_active`. - [Get linked objects metrics](https://developers.airsaas.io/reference/projects_linked_objects_metrics_retrieve.md): Returns aggregated metrics for objects linked to the given **Project**. - [Create a note on a project](https://developers.airsaas.io/reference/projects_notes_create.md): Creates a note on the given **Project**. Provide `text` as Markdown or Quill delta JSON. Returns the created note as a feed item. - [Create a success on a project](https://developers.airsaas.io/reference/projects_successes_create.md): Creates a **success** on the given **Project**. A success is a note with `note_type="success"`. Provide `text` as Markdown or Quill delta JSON. Returns the created success as a feed item. - [List project status history](https://developers.airsaas.io/reference/projects_status_history_list.md): Returns a paginated list of status updates for the **Project**, sorted by most recent first. - [List all project statuses](https://developers.airsaas.io/reference/projects_statuses_list.md): Returns a paginated list of all **Project Statuses** of the workspace. Those status codes can then be used to update a project status, for example. - [Retrieve a project status](https://developers.airsaas.io/reference/projects_statuses_retrieve.md): Retrieves a **Project Status** using the provided ID. - [List all project status groups](https://developers.airsaas.io/reference/project_status_groups_list.md): Returns a paginated list of all active **Project status groups**. - [Retrieve a project status group](https://developers.airsaas.io/reference/project_status_groups_retrieve.md): Retrieves a **Project status group** using the provided ID. - [List all project roles](https://developers.airsaas.io/reference/project_roles_list.md): Returns a paginated list of all **Project roles** of the workspace. - [Retrieve a project role](https://developers.airsaas.io/reference/project_roles_retrieve.md): Retrieves a **Project Role** using the provided ID. - [List all project importances](https://developers.airsaas.io/reference/projects_importances_list.md): Returns a paginated list of all **Project Importances** of the workspace. Those importance codes can then be used to [update a project importance](ref:projects_update_importance_create), for example. - [Retrieve a project importance](https://developers.airsaas.io/reference/projects_importances_retrieve.md): Retrieves a **Project Importance** using the provided ID. - [List all project moods](https://developers.airsaas.io/reference/projects_moods_list.md): Returns a paginated list of all **Project Moods**. Those mood codes can then be used to update a project mood, for example. - [Retrieve a project mood](https://developers.airsaas.io/reference/projects_moods_retrieve.md): Retrieves a **Project Mood** using the provided ID. - [List all project risks](https://developers.airsaas.io/reference/projects_risks_list.md): Returns a paginated list of all **Project Risks**. Those risk codes can then be used to [update a project risk](ref:projects_update_risk_create), for example. - [Retrieve a project risk](https://developers.airsaas.io/reference/projects_risks_retrieve.md): Retrieves a **Project Risk** using the provided ID. - [List all project custom attributes](https://developers.airsaas.io/reference/project_custom_attributes_list.md): Returns a paginated list of all **project custom attributes** in the workspace. - [Retrieve a project custom attribute](https://developers.airsaas.io/reference/project_custom_attributes_retrieve.md): Retrieves a **Project Custom Attribute** using the provided ID. - [Retrieve a project budget line](https://developers.airsaas.io/reference/projects_budget_lines_retrieve.md): Retrieves a **Budget Lines** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `analytical_axis_item` * `analytical_axis_items` Read more in our section about [expandable properties](ref:expandable-properties). **Note:** The `analytical_axis_item` field is deprecated and will be removed in a future version. Use `analytical_axis_items` instead. - [Create a project budget line](https://developers.airsaas.io/reference/projects_budget_lines_create.md): Creates a new **Budget Line** for the given project. **Note:** The `analytical_axis_item` field is deprecated and will be removed in a future version. Use `analytical_axis_items` instead. **Priority:** If both `analytical_axis_item` and `analytical_axis_items` are provided, `analytical_axis_items` takes priority. - [Update a project budget line](https://developers.airsaas.io/reference/projects_budget_lines_partial_update.md): Updates an existing **Budget Line** of the given project. **Note:** The `analytical_axis_item` field is deprecated and will be removed in a future version. Use `analytical_axis_items` instead. **Priority:** If both `analytical_axis_item` and `analytical_axis_items` are provided, `analytical_axis_items` takes priority. - [Delete a project budget line](https://developers.airsaas.io/reference/projects_budget_lines_destroy.md): Deletes an existing **Budget Line** of the given project. - [List all budget values for a project](https://developers.airsaas.io/reference/projects_budget_values_list.md): List all budget values for a project. Only available for projects with yearly budgets enabled. BudgetValue represents a project-level yearly aggregate identified by (year, exp_type). Use this endpoint to read or update CAPEX/OPEX yearly totals directly. For line-level budgeting per budget line and year, use BudgetLineValue endpoints. - [Retrieve a budget value for a project](https://developers.airsaas.io/reference/projects_budget_values_retrieve.md): Retrieve a budget value for a project. Only available for projects with yearly budgets enabled. BudgetValue represents a project-level yearly aggregate identified by (year, exp_type). Use this endpoint to read or update CAPEX/OPEX yearly totals directly. For line-level budgeting per budget line and year, use BudgetLineValue endpoints. - [Create or update a budget value for a project](https://developers.airsaas.io/reference/projects_budget_values_partial_update.md): Create or update a budget value for a project. Only available for projects with yearly budgets enabled. BudgetValue represents a project-level yearly aggregate identified by (year, exp_type). Use this endpoint to read or update CAPEX/OPEX yearly totals directly. For line-level budgeting per budget line and year, use BudgetLineValue endpoints. This endpoint behaves as upsert for (year, exp_type): returns 201 when created and 200 when updated. - [List workspace budget lines across projects](https://developers.airsaas.io/reference/projects_workspace_budget_lines_list.md): Returns a paginated list of **Budget Lines** across all visible and non-archived projects in the current workspace. ### Expandable Properties This endpoint supports relations expansion on: * `project` Read more in our section about [expandable properties](ref:expandable-properties). - [List all project budget lines](https://developers.airsaas.io/reference/projects_nested_budget_lines_list.md): Returns a paginated list of all **Budget Lines** of the given project. ### Expandable Properties This endpoint supports relations expansion on: * `analytical_axis_item` * `analytical_axis_items` Read more in our section about [expandable properties](ref:expandable-properties). **Note:** The `analytical_axis_item` field is deprecated and will be removed in a future version. Use `analytical_axis_items` instead. - [List all effort team values for a project team](https://developers.airsaas.io/reference/projects_effort_team_values_list.md): List all effort team values for a project team. Only available for projects with yearly efforts enabled. - [List all effort team values for a project team](https://developers.airsaas.io/reference/projects_teams_values_list.md): List all effort team values for a project team. Only available for projects with yearly efforts enabled. - [Retrieve an effort team value for a project team](https://developers.airsaas.io/reference/projects_teams_values_retrieve.md): Retrieve an effort team value for a project team. Only available for projects with yearly efforts enabled. - [Create an effort team value for a project team](https://developers.airsaas.io/reference/projects_teams_values_create.md): Create an effort team value for a project team. Only available for projects with yearly efforts enabled. - [Update an effort team value for a project team](https://developers.airsaas.io/reference/projects_teams_values_partial_update.md): Update an effort team value for a project team. Only available for projects with yearly efforts enabled. - [List all budget line values for a budget line](https://developers.airsaas.io/reference/projects_budget_lines_values_list.md): Returns a paginated list of all **budget line values** for the given budget line. BudgetLineValue represents a line-level yearly value identified by (budget_line, year). Use this endpoint for detailed budgeting on each budget line. Updating line values recalculates project-level BudgetValue aggregates for the same fiscal year. - [Retrieve a budget line value for a fiscal year](https://developers.airsaas.io/reference/projects_budget_lines_values_retrieve.md): Retrieves a **budget line value** for the provided fiscal year. BudgetLineValue represents a line-level yearly value identified by (budget_line, year). Use this endpoint for detailed budgeting on each budget line. Updating line values recalculates project-level BudgetValue aggregates for the same fiscal year. - [Create or update a budget line value](https://developers.airsaas.io/reference/projects_budget_lines_values_partial_update.md): Create or update a **budget line value**. BudgetLineValue represents a line-level yearly value identified by (budget_line, year). Use this endpoint for detailed budgeting on each budget line. Updating line values recalculates project-level BudgetValue aggregates for the same fiscal year. This endpoint behaves as upsert for (budget_line, year): returns 201 when created and 200 when updated. - [List all smart views](https://developers.airsaas.io/reference/smartviews_list.md): Returns a paginated list of all **Smart Views** of the workspace, accessible by the authorization token used. - [Retrieve a smart view](https://developers.airsaas.io/reference/smartviews_retrieve.md): Retrieves a **Smart View** using the provided ID. - [Get smart view item IDs](https://developers.airsaas.io/reference/smartviews_item_ids_retrieve.md): Returns the list of item IDs matching the smart view's filter criteria. The items returned depend on the smart view type (project, decision, attention_point, project_milestone, meeting_report). - [Create a smart view](https://developers.airsaas.io/reference/smartviews_create.md): Create a **Smart View** in the current workspace. `workspace` and creator are set from the authorization context. `description` accepts Markdown (same as projects). Roadmap and request-management categories require `type=project` and `private=false`. - [Update a smart view](https://developers.airsaas.io/reference/smartviews_partial_update.md): Partially update a **Smart View**. `type` cannot be changed after creation. - [List smart view projects](https://developers.airsaas.io/reference/smartviews_projects_retrieve.md): Return paginated **Projects** matching the **Smart View** criteria. Only compatible with smart views of type `project` — returns the projects directly matched by the smart view's own filters. - [List smart view milestones](https://developers.airsaas.io/reference/smartviews_milestones_retrieve.md): Return paginated **Milestones** matching the **Smart View** criteria. Compatible with smart views of type `project_milestone` (returns milestones directly matched by the smart view's own filters) or type `project` (returns milestones that belong to the projects matched by the smart view). When the smart view type is `project`, an optional `pinned` filter is available to restrict results to milestones pinned for presentation on the matched projects. - [List smart view decisions](https://developers.airsaas.io/reference/smartviews_decisions_retrieve.md): Return paginated **Decisions** matching the **Smart View** criteria. Compatible with smart views of type `decision` (returns decisions directly matched by the smart view's own filters) or type `project` (returns decisions that are direct children of the projects matched by the smart view). When the smart view type is `project`, an optional `pinned` filter is available to restrict results to decisions pinned on the matched projects. - [List smart view attention points](https://developers.airsaas.io/reference/smartviews_attention_points_retrieve.md): Return paginated **Attention Points** matching the **Smart View** criteria. Compatible with smart views of type `attention_point` (returns attention points directly matched by the smart view's own filters) or type `project` (returns attention points that are direct children of the projects matched by the smart view). When the smart view type is `project`, an optional `pinned` filter is available to restrict results to attention points pinned on the matched projects. - [Get smart view meeting reports](https://developers.airsaas.io/reference/smartviews_meeting_reports_retrieve.md): Returns a paginated list of **Meeting reports** matching the smart view criteria. Supported smart view types: `meeting_report` (direct), `project` (related — meeting reports linked to projects resolved by the smart view). - [List all attention points](https://developers.airsaas.io/reference/attention_points_list.md): Returns a paginated list of all **Attention Points** of the workspace, accessible by the authorization token used. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `project` * `workspace_program` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve an attention point](https://developers.airsaas.io/reference/attention_points_retrieve.md): Retrieves an **Attention Point** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `project` * `workspace_program` Read more in our section about [expandable properties](ref:expandable-properties). - [Create an attention point](https://developers.airsaas.io/reference/attention_points_create.md): Creates an **Attention Point** in the current workspace. - [Update an attention point](https://developers.airsaas.io/reference/attention_points_partial_update.md): Partially updates an **Attention Point**. Parent (`project` or `workspace_program`) cannot be changed after creation. - [Update an attention point status](https://developers.airsaas.io/reference/attention_points_update_status_create.md): Updates the status of the given **Attention Point**. A message **must** be provided to help other workspace users to understand why the status has changed. - [Get last status update](https://developers.airsaas.io/reference/attention_points_last_status_update_retrieve.md): Returns the last status update for the attention point, including the user who made the change, the old and new values, and any comment provided. - [List all program attention points](https://developers.airsaas.io/reference/programs_attention_points_list.md): Returns a paginated list of all **Attention Points** linked to the given **Program**, with the same visibility rules as the workspace attention points list. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `project` * `workspace_program` Read more in our section about [expandable properties](ref:expandable-properties). ### OAuth2 For **OAuth2** bearer tokens, **GET** requires all of these read scopes: `program:read`, `attention_point:read` (resources: `program`, `attention_point`). Alternatively, the umbrella scope `all:read` (GET) or `all:write` (write methods) satisfies any endpoint. ### Note If the parent resource in the URL path cannot be accessed or does not exist, the response is **200** with an empty `results` list. - [List all project attention points](https://developers.airsaas.io/reference/projects_attention_points_list.md): Returns a paginated list of all **Attention Points** linked to the given **Project**, with the same visibility rules as the workspace attention points list. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `project` * `workspace_program` Read more in our section about [expandable properties](ref:expandable-properties). - [List attention point feed](https://developers.airsaas.io/reference/attention_points_feed_list.md): Returns a cursor-based feed for an **Attention Point**. Feed items are sorted by `created_at` descending. Use `before_timestamp` to request older items. The response window is fixed to 10 items. - [Create a note on an attention point](https://developers.airsaas.io/reference/attention_points_notes_create.md): Creates a note on the given **Attention Point**. Provide `text` as Markdown or Quill delta JSON. Returns the created note as a feed item. - [List all attention point custom attributes](https://developers.airsaas.io/reference/attention_point_custom_attributes_list.md): Returns a paginated list of all **attention point custom attributes** in the workspace. - [Retrieve an attention point custom attribute](https://developers.airsaas.io/reference/attention_point_custom_attributes_retrieve.md): Retrieves an **Attention Point Custom Attribute** using the provided ID. - [List all attention point statuses](https://developers.airsaas.io/reference/attention_points_statuses_list.md): Returns a paginated list of all **Attention Point Statuses** of the workspace. - [Retrieve an attention point status](https://developers.airsaas.io/reference/attention_points_statuses_retrieve.md): Retrieves an **Attention Point Status** using the provided ID. - [List all attention point status groups](https://developers.airsaas.io/reference/attention_points_status_groups_list.md): Returns a paginated list of all active **Attention point status groups**. - [Retrieve an attention point status group](https://developers.airsaas.io/reference/attention_points_status_groups_retrieve.md): Retrieves an **Attention point status group** using the provided ID. - [List all attention point severities](https://developers.airsaas.io/reference/attention_points_severities_list.md): Returns a paginated list of all **Attention Point Severities** of the workspace. These severities can be used for various purposes in managing attention points. - [Retrieve an attention point severity](https://developers.airsaas.io/reference/attention_points_severities_retrieve.md): Retrieves an **Attention Point Severity** using the provided ID. - [List all attention point severity groups](https://developers.airsaas.io/reference/attention_points_severity_groups_list.md): Returns a paginated list of all active **Attention point severity groups**. - [Retrieve an attention point severity group](https://developers.airsaas.io/reference/attention_points_severity_groups_retrieve.md): Retrieves an **Attention point severity group** using the provided ID. - [List all attention point urgencies](https://developers.airsaas.io/reference/attention_points_urgencies_list.md): Returns a paginated list of all **Attention Point Urgencies** of the workspace. These urgencies can be used for various purposes in managing attention points. - [Retrieve an attention point urgency](https://developers.airsaas.io/reference/attention_points_urgencies_retrieve.md): Retrieves an **Attention Point Urgency** using the provided ID. - [List all attention point urgency groups](https://developers.airsaas.io/reference/attention_points_urgency_groups_list.md): Returns a paginated list of all active **Attention point urgency groups**. - [Retrieve an attention point urgency group](https://developers.airsaas.io/reference/attention_points_urgency_groups_retrieve.md): Retrieves an **Attention point urgency group** using the provided ID. - [List all attention point probabilities](https://developers.airsaas.io/reference/attention_points_probabilities_list.md): Returns a paginated list of all **Attention Point Probabilities** of the workspace. These probabilities can be used for various purposes in managing attention points. - [Retrieve an attention point probability](https://developers.airsaas.io/reference/attention_points_probabilities_retrieve.md): Retrieves an **Attention Point Probability** using the provided ID. - [List all attention point types](https://developers.airsaas.io/reference/attention_points_types_list.md): Returns a paginated list of all **Attention Point Types** of the workspace. These types can be used for various purposes in managing attention points. - [Retrieve an attention point type](https://developers.airsaas.io/reference/attention_points_types_retrieve.md): Retrieves an **Attention Point Type** using the provided ID. - [List attention point status history](https://developers.airsaas.io/reference/attention_points_status_history_list.md): Returns a paginated list of status updates for the **Attention Point**, sorted by most recent first. - [List all project budget analytical axes](https://developers.airsaas.io/reference/budget_analytical_axis_list.md): Returns a paginated list of all **budget analytical axes** in the workspace. - [Retrieve a budget analytical axis](https://developers.airsaas.io/reference/budget_analytical_axis_retrieve.md): Retrieves a **Budget Analytical Axis** using the provided ID. - [List budget analytical axis items](https://developers.airsaas.io/reference/budget_analytical_axis_items_list.md): Returns a paginated list of all **budget analytical axis items** for the given budget analytical axis. - [Retrieve a budget analytical axis item](https://developers.airsaas.io/reference/budget_analytical_axis_items_retrieve.md): Retrieves a **Budget analytical axis item** using the provided ID. - [Create a budget analytical axis item](https://developers.airsaas.io/reference/budget_analytical_axis_items_create.md): Creates a new **Budget analytical axis item**. - [Update a budget analytical axis item](https://developers.airsaas.io/reference/budget_analytical_axis_items_partial_update.md): Updates an existing **Budget analytical axis item**. - [Delete a budget analytical axis item](https://developers.airsaas.io/reference/budget_analytical_axis_items_destroy.md): Deletes an existing **Budget analytical axis item**. - [Get the current workspace](https://developers.airsaas.io/reference/workspace_retrieve.md): Get the current **Workspace**. - [List capacity periods](https://developers.airsaas.io/reference/capacity_periods_list.md): Returns the computed **Capacity Periods** for the workspace based on its fiscal year configuration. Each period includes a `date_timeframe` value (e.g., `2026_1`) that can be used when creating milestones. **Filtering** Use `after` and `before` to narrow the list. These query parameters are independent from the `start_date` / `end_date` fields in the response: - `after` (YYYY-MM-DD): return only periods whose **end_date** is on or after this date. - `before` (YYYY-MM-DD): return only periods whose **start_date** is on or before this date. **Default behavior** When neither parameter is provided, the endpoint returns periods from January 1 of the current year through December 31 of the next year (approximately two years). When only `after` is provided, `before` defaults to December 31 of the year after `after`. When only `before` is provided, `after` defaults to January 1 of the year before `before`. - [Get workspace global settings](https://developers.airsaas.io/reference/workspace_settings_global_retrieve.md): Get the current **Workspace global settings**. Includes workspace definitions, statuses, custom attributes, enabled options, and accepted contracts. - [Retrieve a feed item](https://developers.airsaas.io/reference/feed_retrieve.md): Returns a single feed item by its stable ``feed_id`` (``{type}-{id}``), using the same serialization pipeline as feed list endpoints. - [List feed item comments](https://developers.airsaas.io/reference/feed_comments_list.md): Returns a paginated list of comments on a feed item identified by ``feed_id``. Comments are sorted by ``created_at`` descending. Each item includes reactions and attachments. - [Add a comment on a feed item](https://developers.airsaas.io/reference/feed_comments_create.md): Creates a new **Comment** on the feed item identified by ``feed_id``. Only commentable feed types (``note``, ``activitylog``, ``projectfeedback``, ``productpersonrating``) are accepted; ``decision`` and ``attentionpoint``, milestone and other feed items return 400. The created comment is returned with its author, reactions, and attachments. - [List all gain units](https://developers.airsaas.io/reference/gain_units_list.md): Returns a paginated list of all **Gain Units** in the workspace. - [Retrieve a gain unit](https://developers.airsaas.io/reference/gain_units_retrieve.md): Retrieves a **Gain Unit** using the provided ID. - [List all gain unit types](https://developers.airsaas.io/reference/gain_unit_types_list.md): Returns a paginated list of all **Gain Unit Types** in the workspace. - [Retrieve a gain unit type](https://developers.airsaas.io/reference/gain_unit_types_retrieve.md): Retrieves a **Gain Unit Type** using the provided ID. - [List all gain statuses](https://developers.airsaas.io/reference/gain_statuses_list.md): Returns a paginated list of all active **Gain Statuses** in the workspace. - [Retrieve a gain status](https://developers.airsaas.io/reference/gain_statuses_retrieve.md): Retrieves a **Gain Status** using the provided ID. - [List all gain status groups](https://developers.airsaas.io/reference/gain_status_groups_list.md): Returns a paginated list of all active **Gain status groups**. - [Retrieve a gain status group](https://developers.airsaas.io/reference/gain_status_groups_retrieve.md): Retrieves a **Gain status group** using the provided ID. - [List all gain natures](https://developers.airsaas.io/reference/gain_natures_list.md): Returns a paginated list of all **Gain Natures** in the workspace. - [Retrieve a gain nature](https://developers.airsaas.io/reference/gain_natures_retrieve.md): Retrieves a **Gain Nature** using the provided ID. - [List all gains](https://developers.airsaas.io/reference/gains_list.md): Returns a paginated list of all **Gains** of the workspace, accessible by the authorization token used. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `data_owner` * `project` * `workspace_program` * `nature` * `unit` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve a gain](https://developers.airsaas.io/reference/gains_retrieve.md): Retrieves a **Gain** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `data_owner` * `project` * `workspace_program` * `nature` * `unit` Read more in our section about [expandable properties](ref:expandable-properties). - [Get last weather update](https://developers.airsaas.io/reference/gains_last_weather_update_retrieve.md): Returns the last weather (health) update for the gain, including the user who made the change, the old and new values, and any comment provided. - [List all gain health values](https://developers.airsaas.io/reference/gain_health_list.md): Returns a paginated list of all active **Gain Health** values. - [Retrieve a gain health value](https://developers.airsaas.io/reference/gain_health_retrieve.md): Retrieves a **Gain Health** value using the provided code. - [List all goals](https://developers.airsaas.io/reference/goals_list.md): Returns a paginated list of all **Goals** of the workspace. - [Retrieve a goal](https://developers.airsaas.io/reference/goals_retrieve.md): Retrieves a **Goal** using the provided ID. - [List all meeting reports](https://developers.airsaas.io/reference/meeting_reports_list.md): Returns a paginated list of **Meeting reports** accessible to the authorization token used. Includes published meeting reports the user can access, plus draft meeting reports created by the authenticated user. ### Expandable Properties This endpoint supports relations expansion on: * `created_by` * `published_by` * `project` * `workspace_program` * `participants` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve a meeting report](https://developers.airsaas.io/reference/meeting_reports_retrieve.md): Retrieves a **Meeting report** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `created_by` * `published_by` * `project` * `workspace_program` * `participants` Read more in our section about [expandable properties](ref:expandable-properties). - [List all milestones](https://developers.airsaas.io/reference/milestones_list.md): Returns a paginated list of all **milestones** in the workspace. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `team` * `project` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve a milestone](https://developers.airsaas.io/reference/milestones_retrieve.md): Retrieves a **Milestone** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `team` * `project` Read more in our section about [expandable properties](ref:expandable-properties). - [Create a milestone](https://developers.airsaas.io/reference/projects_milestones_create.md): Create a **Milestone**. - [Update a milestone](https://developers.airsaas.io/reference/projects_milestones_partial_update.md): Update **Milestone** properties. - [List milestone feed](https://developers.airsaas.io/reference/milestones_feed_list.md): Returns a cursor-based feed for a **Milestone**. Feed items are sorted by `created_at` descending. Use `before_timestamp` to request older items. The response window is fixed to 10 items. - [Get last status update](https://developers.airsaas.io/reference/milestones_last_status_update_retrieve.md): Returns the last status update for the milestone, including the user who made the change, the old and new values, and any comment provided. - [Get last weather update](https://developers.airsaas.io/reference/milestones_last_weather_update_retrieve.md): Returns the last weather (health) update for the milestone, including the user who made the change, the old and new values, and any comment provided. - [List milestone weather history](https://developers.airsaas.io/reference/milestones_weather_history_list.md): Returns a paginated list of weather (health) updates for the milestone, sorted by most recent first. - [Create a note on a milestone](https://developers.airsaas.io/reference/milestones_notes_create.md): Creates a note on the given **Milestone**. Provide `text` as Markdown or Quill delta JSON. Returns the created note as a feed item. - [Update milestone weather](https://developers.airsaas.io/reference/milestones_update_weather_create.md): Updates the weather (health) of the given **Milestone**. A message **must** be provided to help other workspace users understand why the health has changed. - [List all workspace milestone efforts](https://developers.airsaas.io/reference/milestone_efforts_list.md): Returns a paginated list of all **Milestone Efforts** of the workspace. These effort codes can be used when creating or updating milestones. - [Retrieve a milestone effort](https://developers.airsaas.io/reference/milestone_efforts_retrieve.md): Retrieves a **Milestone Effort** using the provided code. - [List all milestones health](https://developers.airsaas.io/reference/milestone_health_list.md): Returns a paginated list of all **milestone health** values in the workspace. - [Retrieve a milestone health](https://developers.airsaas.io/reference/milestone_health_retrieve.md): Retrieves a **Milestone health** using the provided code. - [List milestone teams](https://developers.airsaas.io/reference/milestones_teams_list.md): Returns a list of all **Teams** associated with a milestone, including their effort values. ### Expandable Properties This endpoint supports relations expansion on: * `team` Read more in our section about [expandable properties](ref:expandable-properties). - [Add a team to a milestone](https://developers.airsaas.io/reference/milestones_teams_create.md): Associates a new **Team** with a milestone and sets effort values. - [Retrieve a milestone team](https://developers.airsaas.io/reference/milestones_teams_retrieve.md): Retrieves effort details for a specific **Team** on a milestone. ### Expandable Properties This endpoint supports relations expansion on: * `team` Read more in our section about [expandable properties](ref:expandable-properties). - [Update a milestone team effort](https://developers.airsaas.io/reference/milestones_teams_partial_update.md): Updates effort values for an existing **Team** on a milestone. - [Remove a team from a milestone](https://developers.airsaas.io/reference/milestones_teams_destroy.md): Removes a **Team** from a milestone and deletes associated effort. - [List milestone teams](https://developers.airsaas.io/reference/projects_milestones_teams_list.md): Returns a list of all **Teams** associated with a milestone, including their effort values. ### Expandable Properties This endpoint supports relations expansion on: * `team` Read more in our section about [expandable properties](ref:expandable-properties). - [Add a team to a milestone](https://developers.airsaas.io/reference/projects_milestones_teams_create.md): Associates a new **Team** with a milestone and sets effort values. - [Retrieve a milestone team](https://developers.airsaas.io/reference/projects_milestones_teams_retrieve.md): Retrieves effort details for a specific **Team** on a milestone. ### Expandable Properties This endpoint supports relations expansion on: * `team` Read more in our section about [expandable properties](ref:expandable-properties). - [Update a milestone team effort](https://developers.airsaas.io/reference/projects_milestones_teams_partial_update.md): Updates effort values for an existing **Team** on a milestone. - [Remove a team from a milestone](https://developers.airsaas.io/reference/projects_milestones_teams_destroy.md): Removes a **Team** from a milestone and deletes associated effort. - [List all milestone status groups](https://developers.airsaas.io/reference/milestone_status_groups_list.md): Returns a paginated list of all active **Milestone status groups**. - [Retrieve a milestone status group](https://developers.airsaas.io/reference/milestone_status_groups_retrieve.md): Retrieves a **Milestone status group** using the provided ID. - [List all milestone custom attributes](https://developers.airsaas.io/reference/milestone_custom_attributes_list.md): Returns a paginated list of all **milestone custom attributes** in the workspace. - [Retrieve a milestone custom attribute](https://developers.airsaas.io/reference/milestone_custom_attributes_retrieve.md): Retrieves a **Milestone Custom Attribute** using the provided ID. - [List milestone status history](https://developers.airsaas.io/reference/milestones_status_history_list.md): Returns a paginated list of status updates for the **Milestone**, sorted by most recent first. - [List all programs](https://developers.airsaas.io/reference/programs_list.md): Returns a paginated list of all **Programs** of the workspace. ### Expandable Properties This endpoint supports relations expansion on: * `leader` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve a program](https://developers.airsaas.io/reference/programs_retrieve.md): Retrieves a **Program** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `leader` Read more in our section about [expandable properties](ref:expandable-properties). - [List all program projects](https://developers.airsaas.io/reference/programs_projects_list.md): Returns a paginated list of all **Projects** assigned to the given **Program**, with the same visibility rules as the workspace projects list. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `program` * `goals` * `teams` * `requesting_team` Read more in our section about [expandable properties](ref:expandable-properties). ### OAuth2 For **OAuth2** bearer tokens, **GET** requires all of these read scopes: `program:read`, `project:read` (resources: `program`, `project`). Alternatively, the umbrella scope `all:read` (GET) or `all:write` (write methods) satisfies any endpoint. ### Note If the parent resource in the URL path cannot be accessed or does not exist, the response is **200** with an empty `results` list. - [List program feed](https://developers.airsaas.io/reference/programs_feed_list.md): Returns a cursor-based feed for a **Program**. Feed items are sorted by `created_at` descending. Use `before_timestamp` to request older items. The response window is fixed to 10 items. - [Get last weather update](https://developers.airsaas.io/reference/programs_last_weather_update_retrieve.md): Returns the last weather (health) update for the program, including the user who made the change, the old and new values, and any comment provided. - [List program weather history](https://developers.airsaas.io/reference/programs_weather_history_list.md): Returns a paginated list of weather (health) updates for the program, sorted by most recent first. - [Update program weather](https://developers.airsaas.io/reference/programs_update_weather_create.md): Updates the weather (health) of the given **Program**. A message **must** be provided to help other workspace users understand why the health has changed. - [Create a note on a program](https://developers.airsaas.io/reference/programs_notes_create.md): Creates a note on the given **Program**. Provide `text` as Markdown or Quill delta JSON. Returns the created note as a feed item. - [Archive a program](https://developers.airsaas.io/reference/programs_archive_create.md): Archives the given **Program**. All child projects (and their milestones, decisions, attention points, meeting reports) will also be archived. If the program is already archived, the response `status` will be `already_archived`. - [Unarchive a program](https://developers.airsaas.io/reference/programs_unarchive_create.md): Unarchives (restores) the given **Program**. Child projects that were archived together with this program will also be restored. If the program is already active, the response `status` will be `already_active`. - [Get linked objects metrics](https://developers.airsaas.io/reference/programs_linked_objects_metrics_retrieve.md): Returns aggregated metrics for objects linked to the given **Program**. - [List all program health](https://developers.airsaas.io/reference/program_health_list.md): Returns a paginated list of all **program health** values in the workspace. - [Retrieve a program health](https://developers.airsaas.io/reference/program_health_retrieve.md): Retrieves a **Program Health** using the provided code. - [List all program custom attributes](https://developers.airsaas.io/reference/program_custom_attributes_list.md): Returns a paginated list of all **program custom attributes** in the workspace. - [Retrieve a program custom attribute](https://developers.airsaas.io/reference/program_custom_attributes_retrieve.md): Retrieves a **Program Custom Attribute** using the provided ID. - [Retrieve extended program](https://developers.airsaas.io/reference/programs_extended_retrieve.md): Returns extended program data: all standard fields with leader expanded, plus last weather update, linked-object metrics, and all pinned feed items. - [List all quarter plans](https://developers.airsaas.io/reference/quarter_plans_list.md): Returns a paginated list of all **Quarter Plans** of the workspace. - [Retrieve a quarter plan](https://developers.airsaas.io/reference/quarter_plans_retrieve.md): Retrieves a **Quarter Plan** using the provided ID. - [List quarter plan milestones](https://developers.airsaas.io/reference/quarter_plans_milestones_list.md): Returns a paginated list of **Milestones** belonging to the given **Quarter Plan**. Use the required `set` parameter to choose live or frozen milestone data. For frozen sets, expanded `owner` uses the current person profile for the snapshot owner id; `team` and `project` are resolved from the freeze snapshot. Frozen responses only include milestones that still exist in the workspace and are visible to the caller under current project access rules. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `team` * `project` Read more in our section about [expandable properties](ref:expandable-properties). - [List quarter plan projects](https://developers.airsaas.io/reference/quarter_plans_projects_list.md): Returns a paginated list of **Projects** belonging to the given **Quarter Plan**. Use the `set` query parameter to select which project set to return: `live` for current database state, `frozen_in_scope` for the snapshot taken when the quarter plan entered execution, or `frozen_when_finished` for the snapshot taken when the quarter plan was marked as finished. ### Expandable Properties This endpoint supports relations expansion on: * `owner` * `program` * `goals` * `teams` * `requesting_team` Read more in our section about [expandable properties](ref:expandable-properties). ### OAuth2 For **OAuth2** bearer tokens, **GET** requires all of these read scopes: `quarter_plan:read`, `project:read` (resources: `quarter_plan`, `project`). Alternatively, the umbrella scope `all:read` (GET) or `all:write` (write methods) satisfies any endpoint. ### Note If the parent resource in the URL path does not exist, the response is **404 Not Found**. - [Get quarter plan metrics](https://developers.airsaas.io/reference/quarter_plans_metrics_retrieve.md): Returns all dashboard metrics for the given **Quarter Plan**. Use the required `set` parameter to choose between live data or a frozen snapshot. The response is a key-value object where each key is a metric code and each value contains a `name`, `description`, and `value`. The set of returned metrics depends on the plan's current status and workspace feature flags — consumers should not assume a fixed set of keys. - [List milestone changes](https://developers.airsaas.io/reference/quarter_plans_milestones_changes_retrieve.md): Returns the **Milestone** changes for the **Quarter Plan**, comparing the current version against the scope-freeze baseline. The two versions compared are determined by the plan status. - [List project changes](https://developers.airsaas.io/reference/quarter_plans_projects_changes_retrieve.md): Returns the **Project** changes for the **Quarter Plan**, comparing the current version against the scope-freeze baseline. The two versions compared are determined by the plan status. ### OAuth2 For **OAuth2** bearer tokens, **GET** requires all of these read scopes: `quarter_plan:read`, `project:read` (resources: `quarter_plan`, `project`). Alternatively, the umbrella scope `all:read` (GET) or `all:write` (write methods) satisfies any endpoint. ### Note If the parent resource in the URL path does not exist, the response is **404 Not Found**. - [Get metrics changes](https://developers.airsaas.io/reference/quarter_plans_metrics_changes_retrieve.md): Returns the **Quarter Plan** metric changes, comparing the current version against the scope-freeze baseline. The two versions compared are determined by the plan status. - [List all quarter plan status groups](https://developers.airsaas.io/reference/quarter_plan_status_groups_list.md): Returns a list of all **Quarter Plan status groups**. - [List all quarter plan statuses](https://developers.airsaas.io/reference/quarter_plan_statuses_list.md): Returns a paginated list of all **Quarter Plan statuses** of the workspace. - [Retrieve a quarter plan status](https://developers.airsaas.io/reference/quarter_plan_statuses_retrieve.md): Retrieves a **Quarter Plan status** using the provided ID. - [List all teams](https://developers.airsaas.io/reference/teams_list.md): Returns a paginated list of all **Teams** of the workspace. ### Expandable Properties This endpoint supports relations expansion on: * `leader` * `level` * `parent` Read more in our section about [expandable properties](ref:expandable-properties). - [Retrieve a team](https://developers.airsaas.io/reference/teams_retrieve.md): Retrieves a **Team** using the provided ID. ### Expandable Properties This endpoint supports relations expansion on: * `leader` * `level` * `parent` Read more in our section about [expandable properties](ref:expandable-properties). - [List all team levels](https://developers.airsaas.io/reference/team_levels_list.md): Returns a paginated list of all **Team Levels** of the workspace. - [Retrieve a team level](https://developers.airsaas.io/reference/team_levels_retrieve.md): Retrieves a **Team Level** using the provided ID. - [Partially update a team](https://developers.airsaas.io/reference/teams_partial_update.md): Partially updates an existing **Team**. Writable fields: `name`, `description`, `leader`, `parent`, `average_daily_rate` (when human cost feature is enabled). The `parent` field follows the same hierarchy rules as team creation: it must reference a team from the level directly above the team's level, or be `null` only when the team is at the highest level in the workspace. AI configuration fields (`ai_role_definition`, `ai_scopes_included`, `ai_scopes_excluded`, `ai_min_milestones_per_project`, `ai_max_milestones_per_project`) can only be set on level-1 teams. - [Create a team level](https://developers.airsaas.io/reference/team_levels_create.md): Creates a new **Team Level** in the workspace. The `level` integer is assigned automatically as the next level above the current maximum (`max + 1`). Request body: `name` and `icon` only. - [Update a team level](https://developers.airsaas.io/reference/team_levels_partial_update.md): Partially updates an existing **Team Level**. Only `name` and `icon` can be updated. - [Create a team](https://developers.airsaas.io/reference/teams_create.md): Creates a new **Team** in the workspace. The team must be assigned to an existing team level via the `level` field. For non-top-level teams, a `parent` team from the level directly above is required. - [List team capacity periods](https://developers.airsaas.io/reference/teams_capacity_periods_list.md): Returns a paginated list of **Team capacity** periods for the given team, including available effort, planned effort (computed from milestones), delta, and FTE estimate. - [List all team capacity periods](https://developers.airsaas.io/reference/team_capacity_periods_list.md): Returns a paginated list of all **Team capacity** periods across the workspace, with filters to narrow by team, fiscal year, period code, or date range. - [Create or update a team capacity period](https://developers.airsaas.io/reference/team_capacity_periods_create.md): Set the available effort for a **Team capacity** period. If the record for the given team and period code does not exist, it is created automatically from the workspace fiscal configuration. If it already exists, the effort value is updated. - [List team capacity period milestones](https://developers.airsaas.io/reference/teams_capacity_periods_milestones_list.md): Returns a paginated list of **Milestones** assigned to the given team for the specified capacity period. Milestones are filtered by the team's capacity filter and workspace capacity status rules. - [List all users of a workspace](https://developers.airsaas.io/reference/users_list.md): Returns a paginated list of all **Users** of the workspace. - [Retrieve a workspace user](https://developers.airsaas.io/reference/users_retrieve.md): Retrieves a **User** (workspace membership) using the membership id or user id.