openapi: 3.1.0 info: title: Aha! Account backups Products API version: 1.0.0 description: Complete API documentation for Aha! generated from actual test responses contact: name: Aha! Support url: https://www.aha.io/support servers: - url: https://{account-domain}.aha.io/api/v1 description: Aha! API Server variables: account-domain: description: Your Aha! account domain default: company security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] tags: - name: Products paths: /api/v1/products/{id}: get: summary: Get a specific product description: null tags: - Products parameters: - name: id in: path required: true schema: type: string description: Id identifier responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ProductsGetResponse' example: product: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false product_line_type: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' description: id: '21164619' body: '' editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/projects/PRJ1 resource: http://company.aha.io/projects/PRJ1 children: [] custom_fields: - id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet screen_definition_ids: Approval: 475481209 Competitor: 826556567 Epic: 908690576 Feature: 19837977 Ideas::Idea: 405267877 Ideas::IdeaPortal: 790680888 Initiative: 838774462 Page: 26499634 Project: 524951996 Release: 647403809 Requirement: 687341318 StrategicImperative: 117022249 screen_definitions: - id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false - id: 26499634 screenable_type: Page name: Screen Definition 7 custom_field_definitions: - id: 529933329 key: review_date position: 1 name: Review date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 117022249 screenable_type: StrategicImperative name: Screen Definition 13 custom_field_definitions: [] - id: 405267877 screenable_type: Ideas::Idea name: Screen Definition 5 custom_field_definitions: - id: 711072024 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 475481209 screenable_type: Task name: Approvals custom layout custom_field_definitions: [] - id: 524951996 screenable_type: Project name: Screen Definition 1 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 221120583 key: website position: 2 name: Website type: CustomFieldDefinitions::UrlField api_type: url required: false - id: 647403809 screenable_type: Release name: Screen Definition 8 custom_field_definitions: - id: 3228193 key: release_custom_date position: 1 name: Release custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 687341318 screenable_type: Requirement name: Screen Definition 11 custom_field_definitions: - id: 85990596 key: priority position: 3 name: Priority type: CustomFieldDefinitions::SelectConstant api_type: string configuration_display: null required: false options: - id: 135354995 label: P4 - id: 376819668 label: P3 - id: 561184585 label: P2 - id: 947629821 label: P1 - id: 1058433764 label: P5 - id: 867049992 key: requested_by position: 2 name: Requested By type: CustomFieldDefinitions::TextField api_type: string required: false - id: 790680888 screenable_type: Ideas::IdeaPortal name: Screen Definition 4 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 826556567 screenable_type: Competitor name: Screen Definition 3 custom_field_definitions: [] - id: 838774462 screenable_type: Initiative name: Screen Definition 12 custom_field_definitions: - id: 250383571 key: customers position: 1 name: Customers type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 688549069 key: initiative_custom_date position: 3 name: Initiative custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 908690576 screenable_type: Epic name: Screen Definition 7 custom_field_definitions: - id: 919440521 key: epic_custom_date position: 1 name: Epic custom date type: CustomFieldDefinitions::DateField api_type: date required: false has_ideas: true has_master_features: false has_epics: false release_workflow: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: id: 1024772447 name: Account product key result workflow statusable_type: KeyResult workflow_type: key_result capacity_planning_enabled: false default_capacity_units: 10 enhanced_capacity_planning_enabled: false workspace_type: product_workspace security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] /api/v1/products: post: summary: Create a product description: null tags: - Products parameters: [] responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ProductsPostResponse' example: product: id: '6776881149497073946' reference_prefix: NEWPRODUCT name: New Product Line product_line: true product_line_type: a new product line type created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' description: id: '6776881149488051949' body: An amazing new product line editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/projects/NEWPRODUCT resource: http://company.aha.io/projects/NEWPRODUCT children: [] custom_fields: [] screen_definition_ids: {} screen_definitions: [] has_ideas: false has_master_features: true has_epics: true release_workflow: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: key_result capacity_planning_enabled: false default_capacity_units: 10 enhanced_capacity_planning_enabled: false workspace_type: product_workspace security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProductsPostRequest' example: product: name: New Product description: An amazing new product prefix: NEWPRODUCT get: summary: List products in the account description: null tags: - Products parameters: - name: include_teams in: query required: false schema: type: string example: 'true' - name: with_idea_portals in: query required: false schema: type: string example: 'true' responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ProductsGetResponse' example: products: - id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 - id: '517761884' reference_prefix: PRJ2 name: Project 2 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ2 - id: '702241743' reference_prefix: PRJ3 name: Project 3 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ3 pagination: total_records: 3 total_pages: 1 current_page: 1 security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] components: schemas: ProductsPostRequest: type: object properties: product: type: object properties: name: type: string example: New Product description: type: string example: An amazing new product prefix: type: string example: NEWPRODUCT example: name: New Product description: An amazing new product prefix: NEWPRODUCT example: product: name: New Product description: An amazing new product prefix: NEWPRODUCT ProductsPostResponse: type: object properties: product: type: object properties: id: type: string example: '6776881149497073946' reference_prefix: type: string example: NEWPRODUCT name: type: string example: New Product Line product_line: type: boolean example: true product_line_type: type: string example: a new product line type created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' description: type: object properties: id: type: string example: '6776881149488051949' body: type: string example: An amazing new product line editor_version: type: integer example: 2 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' attachments: type: array items: {} example: id: '6776881149488051949' body: An amazing new product line editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: type: string example: http://company.aha.io/projects/NEWPRODUCT resource: type: string example: http://company.aha.io/projects/NEWPRODUCT children: type: array items: {} custom_fields: type: array items: {} screen_definition_ids: type: object properties: {} example: {} screen_definitions: type: array items: {} has_ideas: type: boolean example: false has_master_features: type: boolean example: true has_epics: type: boolean example: true release_workflow: type: object properties: id: type: integer example: 717623509 name: type: string example: Account product release workflow statusable_type: type: string example: Release workflow_type: type: string example: release example: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: type: object properties: id: type: integer example: 845522269 name: type: string example: Example product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: requirement example: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: type: object properties: id: type: integer example: 845522269 name: type: string example: Example product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: feature example: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: type: object properties: id: type: integer example: 61191651 name: type: string example: Account initiative workflow statusable_type: type: string example: Initiative workflow_type: type: string example: initiative example: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: type: object properties: id: type: integer example: 845522269 name: type: string example: Example product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: epic example: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: type: object properties: id: type: integer example: 80245244 name: type: string example: Account product idea workflow statusable_type: type: string example: Idea workflow_type: type: string example: idea example: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: type: object properties: id: type: integer example: 883066232 name: type: string example: Account goal workflow statusable_type: type: string example: StrategicImperative workflow_type: type: string example: strategic_imperative example: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: type: object properties: id: type: integer example: 934299270 name: type: string example: Account document workflow statusable_type: type: string example: Page workflow_type: type: string example: page example: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: type: object properties: id: type: integer example: 883066232 name: type: string example: Account goal workflow statusable_type: type: string example: StrategicImperative workflow_type: type: string example: key_result example: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: key_result capacity_planning_enabled: type: boolean example: false default_capacity_units: type: integer example: 10 enhanced_capacity_planning_enabled: type: boolean example: false workspace_type: type: string example: product_workspace example: id: '6776881149497073946' reference_prefix: NEWPRODUCT name: New Product Line product_line: true product_line_type: a new product line type created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' description: id: '6776881149488051949' body: An amazing new product line editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/projects/NEWPRODUCT resource: http://company.aha.io/projects/NEWPRODUCT children: [] custom_fields: [] screen_definition_ids: {} screen_definitions: [] has_ideas: false has_master_features: true has_epics: true release_workflow: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: key_result capacity_planning_enabled: false default_capacity_units: 10 enhanced_capacity_planning_enabled: false workspace_type: product_workspace example: product: id: '6776881149497073946' reference_prefix: NEWPRODUCT name: New Product Line product_line: true product_line_type: a new product line type created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' description: id: '6776881149488051949' body: An amazing new product line editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/projects/NEWPRODUCT resource: http://company.aha.io/projects/NEWPRODUCT children: [] custom_fields: [] screen_definition_ids: {} screen_definitions: [] has_ideas: false has_master_features: true has_epics: true release_workflow: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: id: 845522269 name: Example product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: key_result capacity_planning_enabled: false default_capacity_units: 10 enhanced_capacity_planning_enabled: false workspace_type: product_workspace ProductsGetResponse: type: object properties: product: type: object properties: id: type: string example: '131414752' reference_prefix: type: string example: PRJ1 name: type: string example: Project 1 product_line: type: boolean example: false product_line_type: type: 'null' created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' description: type: object properties: id: type: string example: '21164619' body: type: string example: '' editor_version: type: integer example: 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' attachments: type: array items: {} example: id: '21164619' body: '' editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: type: string example: http://company.aha.io/projects/PRJ1 resource: type: string example: http://company.aha.io/projects/PRJ1 children: type: array items: {} custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string value: type: string type: type: string example: id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet example: - id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet screen_definition_ids: type: object properties: Approval: type: integer example: 475481209 Competitor: type: integer example: 826556567 Epic: type: integer example: 908690576 Feature: type: integer example: 19837977 Ideas::Idea: type: integer example: 405267877 Ideas::IdeaPortal: type: integer example: 790680888 Initiative: type: integer example: 838774462 Page: type: integer example: 26499634 Project: type: integer example: 524951996 Release: type: integer example: 647403809 Requirement: type: integer example: 687341318 StrategicImperative: type: integer example: 117022249 example: Approval: 475481209 Competitor: 826556567 Epic: 908690576 Feature: 19837977 Ideas::Idea: 405267877 Ideas::IdeaPortal: 790680888 Initiative: 838774462 Page: 26499634 Project: 524951996 Release: 647403809 Requirement: 687341318 StrategicImperative: 117022249 screen_definitions: type: array items: type: object properties: id: type: string screenable_type: type: string name: type: string custom_field_definitions: type: string example: id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false example: - id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false - id: 26499634 screenable_type: Page name: Screen Definition 7 custom_field_definitions: - id: 529933329 key: review_date position: 1 name: Review date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 117022249 screenable_type: StrategicImperative name: Screen Definition 13 custom_field_definitions: [] - id: 405267877 screenable_type: Ideas::Idea name: Screen Definition 5 custom_field_definitions: - id: 711072024 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 475481209 screenable_type: Task name: Approvals custom layout custom_field_definitions: [] - id: 524951996 screenable_type: Project name: Screen Definition 1 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 221120583 key: website position: 2 name: Website type: CustomFieldDefinitions::UrlField api_type: url required: false - id: 647403809 screenable_type: Release name: Screen Definition 8 custom_field_definitions: - id: 3228193 key: release_custom_date position: 1 name: Release custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 687341318 screenable_type: Requirement name: Screen Definition 11 custom_field_definitions: - id: 85990596 key: priority position: 3 name: Priority type: CustomFieldDefinitions::SelectConstant api_type: string configuration_display: null required: false options: - id: 135354995 label: P4 - id: 376819668 label: P3 - id: 561184585 label: P2 - id: 947629821 label: P1 - id: 1058433764 label: P5 - id: 867049992 key: requested_by position: 2 name: Requested By type: CustomFieldDefinitions::TextField api_type: string required: false - id: 790680888 screenable_type: Ideas::IdeaPortal name: Screen Definition 4 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 826556567 screenable_type: Competitor name: Screen Definition 3 custom_field_definitions: [] - id: 838774462 screenable_type: Initiative name: Screen Definition 12 custom_field_definitions: - id: 250383571 key: customers position: 1 name: Customers type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 688549069 key: initiative_custom_date position: 3 name: Initiative custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 908690576 screenable_type: Epic name: Screen Definition 7 custom_field_definitions: - id: 919440521 key: epic_custom_date position: 1 name: Epic custom date type: CustomFieldDefinitions::DateField api_type: date required: false has_ideas: type: boolean example: true has_master_features: type: boolean example: false has_epics: type: boolean example: false release_workflow: type: object properties: id: type: integer example: 717623509 name: type: string example: Account product release workflow statusable_type: type: string example: Release workflow_type: type: string example: release example: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: type: object properties: id: type: integer example: 499195972 name: type: string example: Account product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: requirement example: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: type: object properties: id: type: integer example: 499195972 name: type: string example: Account product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: feature example: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: type: object properties: id: type: integer example: 61191651 name: type: string example: Account initiative workflow statusable_type: type: string example: Initiative workflow_type: type: string example: initiative example: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: type: object properties: id: type: integer example: 499195972 name: type: string example: Account product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: epic example: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: type: object properties: id: type: integer example: 80245244 name: type: string example: Account product idea workflow statusable_type: type: string example: Idea workflow_type: type: string example: idea example: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: type: object properties: id: type: integer example: 883066232 name: type: string example: Account goal workflow statusable_type: type: string example: StrategicImperative workflow_type: type: string example: strategic_imperative example: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: type: object properties: id: type: integer example: 934299270 name: type: string example: Account document workflow statusable_type: type: string example: Page workflow_type: type: string example: page example: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: type: object properties: id: type: integer example: 1024772447 name: type: string example: Account product key result workflow statusable_type: type: string example: KeyResult workflow_type: type: string example: key_result example: id: 1024772447 name: Account product key result workflow statusable_type: KeyResult workflow_type: key_result capacity_planning_enabled: type: boolean example: false default_capacity_units: type: integer example: 10 enhanced_capacity_planning_enabled: type: boolean example: false workspace_type: type: string example: product_workspace example: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false product_line_type: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' description: id: '21164619' body: '' editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/projects/PRJ1 resource: http://company.aha.io/projects/PRJ1 children: [] custom_fields: - id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet screen_definition_ids: Approval: 475481209 Competitor: 826556567 Epic: 908690576 Feature: 19837977 Ideas::Idea: 405267877 Ideas::IdeaPortal: 790680888 Initiative: 838774462 Page: 26499634 Project: 524951996 Release: 647403809 Requirement: 687341318 StrategicImperative: 117022249 screen_definitions: - id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false - id: 26499634 screenable_type: Page name: Screen Definition 7 custom_field_definitions: - id: 529933329 key: review_date position: 1 name: Review date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 117022249 screenable_type: StrategicImperative name: Screen Definition 13 custom_field_definitions: [] - id: 405267877 screenable_type: Ideas::Idea name: Screen Definition 5 custom_field_definitions: - id: 711072024 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 475481209 screenable_type: Task name: Approvals custom layout custom_field_definitions: [] - id: 524951996 screenable_type: Project name: Screen Definition 1 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 221120583 key: website position: 2 name: Website type: CustomFieldDefinitions::UrlField api_type: url required: false - id: 647403809 screenable_type: Release name: Screen Definition 8 custom_field_definitions: - id: 3228193 key: release_custom_date position: 1 name: Release custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 687341318 screenable_type: Requirement name: Screen Definition 11 custom_field_definitions: - id: 85990596 key: priority position: 3 name: Priority type: CustomFieldDefinitions::SelectConstant api_type: string configuration_display: null required: false options: - id: 135354995 label: P4 - id: 376819668 label: P3 - id: 561184585 label: P2 - id: 947629821 label: P1 - id: 1058433764 label: P5 - id: 867049992 key: requested_by position: 2 name: Requested By type: CustomFieldDefinitions::TextField api_type: string required: false - id: 790680888 screenable_type: Ideas::IdeaPortal name: Screen Definition 4 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 826556567 screenable_type: Competitor name: Screen Definition 3 custom_field_definitions: [] - id: 838774462 screenable_type: Initiative name: Screen Definition 12 custom_field_definitions: - id: 250383571 key: customers position: 1 name: Customers type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 688549069 key: initiative_custom_date position: 3 name: Initiative custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 908690576 screenable_type: Epic name: Screen Definition 7 custom_field_definitions: - id: 919440521 key: epic_custom_date position: 1 name: Epic custom date type: CustomFieldDefinitions::DateField api_type: date required: false has_ideas: true has_master_features: false has_epics: false release_workflow: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: id: 1024772447 name: Account product key result workflow statusable_type: KeyResult workflow_type: key_result capacity_planning_enabled: false default_capacity_units: 10 enhanced_capacity_planning_enabled: false workspace_type: product_workspace example: product: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false product_line_type: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' description: id: '21164619' body: '' editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/projects/PRJ1 resource: http://company.aha.io/projects/PRJ1 children: [] custom_fields: - id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet screen_definition_ids: Approval: 475481209 Competitor: 826556567 Epic: 908690576 Feature: 19837977 Ideas::Idea: 405267877 Ideas::IdeaPortal: 790680888 Initiative: 838774462 Page: 26499634 Project: 524951996 Release: 647403809 Requirement: 687341318 StrategicImperative: 117022249 screen_definitions: - id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false - id: 26499634 screenable_type: Page name: Screen Definition 7 custom_field_definitions: - id: 529933329 key: review_date position: 1 name: Review date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 117022249 screenable_type: StrategicImperative name: Screen Definition 13 custom_field_definitions: [] - id: 405267877 screenable_type: Ideas::Idea name: Screen Definition 5 custom_field_definitions: - id: 711072024 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 475481209 screenable_type: Task name: Approvals custom layout custom_field_definitions: [] - id: 524951996 screenable_type: Project name: Screen Definition 1 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 221120583 key: website position: 2 name: Website type: CustomFieldDefinitions::UrlField api_type: url required: false - id: 647403809 screenable_type: Release name: Screen Definition 8 custom_field_definitions: - id: 3228193 key: release_custom_date position: 1 name: Release custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 687341318 screenable_type: Requirement name: Screen Definition 11 custom_field_definitions: - id: 85990596 key: priority position: 3 name: Priority type: CustomFieldDefinitions::SelectConstant api_type: string configuration_display: null required: false options: - id: 135354995 label: P4 - id: 376819668 label: P3 - id: 561184585 label: P2 - id: 947629821 label: P1 - id: 1058433764 label: P5 - id: 867049992 key: requested_by position: 2 name: Requested By type: CustomFieldDefinitions::TextField api_type: string required: false - id: 790680888 screenable_type: Ideas::IdeaPortal name: Screen Definition 4 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 826556567 screenable_type: Competitor name: Screen Definition 3 custom_field_definitions: [] - id: 838774462 screenable_type: Initiative name: Screen Definition 12 custom_field_definitions: - id: 250383571 key: customers position: 1 name: Customers type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 688549069 key: initiative_custom_date position: 3 name: Initiative custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 908690576 screenable_type: Epic name: Screen Definition 7 custom_field_definitions: - id: 919440521 key: epic_custom_date position: 1 name: Epic custom date type: CustomFieldDefinitions::DateField api_type: date required: false has_ideas: true has_master_features: false has_epics: false release_workflow: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: id: 1024772447 name: Account product key result workflow statusable_type: KeyResult workflow_type: key_result capacity_planning_enabled: false default_capacity_units: 10 enhanced_capacity_planning_enabled: false workspace_type: product_workspace securitySchemes: OAuth2: type: oauth2 description: OAuth2 authentication with bearer tokens flows: authorizationCode: authorizationUrl: https://{account-domain}.aha.io/oauth/authorize tokenUrl: https://{account-domain}.aha.io/oauth/token scopes: {} ApiKeyAuth: type: http scheme: bearer description: API key authentication using Bearer token in Authorization header. Generate API keys at https://secure.aha.io/settings/api_keys CookieAuth: type: apiKey in: cookie name: session description: Cookie-based authentication for web browser integration