{ "opencollection": "1.0.0", "info": { "name": "Aha! API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Account backups", "type": "folder" }, "items": [ { "info": { "name": "List account backups", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/account_backups", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Account backups let you create a complete off-site backup of your Aha! account.\nThey can be [created](/api/resources/account_backups/create_an_account_backup),\n[listed](/api/resources/account_backups/list_account_backups), and [downloaded](/api/resources/account_backups/download_an_account_backup) via the API.\n\nAn account backup may only be created once every 24 hours.\n\nThe backup file contains a representation of all of the data in the Aha! account, including all relationships. \nIt does not con" }, { "info": { "name": "Create an account backup", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/account_backups", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The backup may take some time to generate (as long as ten minutes in a \nlarge account). You should poll the GET endpoint to see when the backup \nis complete. You should not poll more frequently than once every twenty \nseconds. Returns an HTTP status of 429 if a backup was already created\nwithin the last 24 hours." }, { "info": { "name": "Get a specific account backup", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/account_backups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The status field indicates whether the backup is ready. The possible\nvalues are: 0 (queued), 1 (in progress), 2 (completed), 3 (error)." }, { "info": { "name": "Download an account backup", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/account_backups/:id.tgz", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Account backups let you create a complete off-site backup of your Aha! account.\nThey can be [created](/api/resources/account_backups/create_an_account_backup),\n[listed](/api/resources/account_backups/list_account_backups), and [downloaded](/api/resources/account_backups/download_an_account_backup) via the API.\n\nAn account backup may only be created once every 24 hours.\n\nThe backup file contains a representation of all of the data in the Aha! account, including all relationships. \nIt does not con" } ] }, { "info": { "name": "Attachments", "type": "folder" }, "items": [ { "info": { "name": "Create an attachment on a comment", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/comments/:comment_id/attachments", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "CommentId identifier" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment[data]", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Uploads a file attachment to a comment using multipart/form-data" }, { "info": { "name": "Create an attachment on an idea comment", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_comments/:idea_comment_id/attachments", "params": [ { "name": "idea_comment_id", "value": "", "type": "path", "description": "IdeaCommentId identifier" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment[data]", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_no" }, { "info": { "name": "Create an attachment on a to-do", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/tasks/:task_id/attachments", "params": [ { "name": "task_id", "value": "", "type": "path", "description": "TaskId identifier" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment[data]", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_no" }, { "info": { "name": "Create an attachment on a custom note field", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_fields/:custom_field_id/attachments", "params": [ { "name": "custom_field_id", "value": "", "type": "path", "description": "CustomFieldId identifier" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment[data]", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_no" }, { "info": { "name": "Create an attachment on a custom attachment field", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_field_values/:custom_field_value_id/attachments", "params": [ { "name": "custom_field_value_id", "value": "", "type": "path", "description": "CustomFieldValueId identifier" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment[data]", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_no" }, { "info": { "name": "Create an attachment on a record description", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/notes/:note_id/attachments", "params": [ { "name": "note_id", "value": "", "type": "path", "description": "NoteId identifier" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment[data]", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Many records throughout Aha! have an associated description: features, requirements, ideas, etc. You can find the ID of a record's description within the `description` attribute returned by any record show endpoint. You can then use that description ID to create an attachment on the record by providing it as the `note_id` URL parameter for this endpoint." }, { "info": { "name": "Delete an attachment", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/attachments/:attachment_id", "params": [ { "name": "attachment_id", "value": "", "type": "path", "description": "AttachmentId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_no" } ] }, { "info": { "name": "Audits", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the history of only the description of a record", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/audits", "params": [ { "name": "associated_id", "value": "1007868956", "type": "query" }, { "name": "associated_type", "value": "Feature", "type": "query" }, { "name": "auditable_type", "value": "Note", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Audit records describe historical changes to records in Aha! and are created automatically when a record is created, updated, or deleted. Audits are immutable and cannot be modified or deleted.\n\nAudits are stored not only for first-class objects such as Features or Release, but also for secondary objects attached to those records such as custom field values, equation field values, descriptions, and record links.\n\nAudit records are only available for the last 12 calendar months. After that, they " } ] }, { "info": { "name": "Historical Audits", "type": "folder" }, "items": [ { "info": { "name": "Read the contents of the historical index", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/historical_audits", "params": [ { "name": "created_since", "value": "2019-01-01T00:00:00Z", "type": "query" }, { "name": "created_before", "value": "2019-01-01T00:00:00Z", "type": "query" }, { "name": "auditable_type", "value": "Feature", "type": "query" }, { "name": "user_id", "value": "1049303076", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The historical audits endpoint is similar to the the Audits endpoint, but searches for audit records generated more than 12 calendar months ago. For searches of more recent data, the much more performant [Audits API](/api/resources/audits) should be used.\n\nThe [historical index](/api/resources/historical_audits/read_the_contents_of_the_historical_index) should first be used to identify time-periods of interest, and then a search can be conducted to fetch the full details of the audit records fro" }, { "info": { "name": "Create an audit search", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/historical_audits", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The historical audits endpoint is similar to the the Audits endpoint, but searches for audit records generated more than 12 calendar months ago. For searches of more recent data, the much more performant [Audits API](/api/resources/audits) should be used.\n\nThe [historical index](/api/resources/historical_audits/read_the_contents_of_the_historical_index) should first be used to identify time-periods of interest, and then a search can be conducted to fetch the full details of the audit records fro" } ] }, { "info": { "name": "Capacity investments", "type": "folder" }, "items": [ { "info": { "name": "List capacity investments for an initiative", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/capacity_investments", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List capacity investments for an initiative" }, { "info": { "name": "Create a capacity investment on an initiative", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/capacity_investments", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a capacity investment on an initiative" }, { "info": { "name": "List capacity investments for an epic", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:epic_id/capacity_investments", "params": [ { "name": "epic_id", "value": "", "type": "path", "description": "EpicId identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List capacity investments for an epic" }, { "info": { "name": "Create a capacity investment on an epic", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:epic_id/capacity_investments", "params": [ { "name": "epic_id", "value": "", "type": "path", "description": "EpicId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a capacity investment on an epic" }, { "info": { "name": "List capacity investments for a feature", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/capacity_investments", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List capacity investments for a feature" }, { "info": { "name": "Create a Capacity Investment with custom fields", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/capacity_investments", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a Capacity Investment with custom fields" }, { "info": { "name": "List capacity investments for a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/capacity_investments", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List capacity investments for a product" }, { "info": { "name": "Get a capacity investment", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/capacity_investments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a capacity investment" }, { "info": { "name": "Update a capacity investment's custom fields", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/capacity_investments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a capacity investment's custom fields" } ] }, { "info": { "name": "Capacity scenarios", "type": "folder" }, "items": [ { "info": { "name": "List capacity scenarios", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/capacity_scenarios", "params": [ { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List capacity scenarios" }, { "info": { "name": "Get a capacity scenario", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/capacity_scenarios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a capacity scenario" } ] }, { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "List comments on a feature", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/comments", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on a feature", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/comments", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on an epic", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:epic_id/comments", "params": [ { "name": "epic_id", "value": "", "type": "path", "description": "EpicId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on an epic", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:epic_id/comments", "params": [ { "name": "epic_id", "value": "", "type": "path", "description": "EpicId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on a requirement", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/:requirement_id/comments", "params": [ { "name": "requirement_id", "value": "", "type": "path", "description": "RequirementId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on a requirement", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/:requirement_id/comments", "params": [ { "name": "requirement_id", "value": "", "type": "path", "description": "RequirementId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on a note", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/pages/:page_id/comments", "params": [ { "name": "page_id", "value": "", "type": "path", "description": "PageId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on a note", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/pages/:page_id/comments", "params": [ { "name": "page_id", "value": "", "type": "path", "description": "PageId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on an idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/comments", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create an internal comment for an idea", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/comments", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on an initiative", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/comments", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on an initiative", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/comments", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on a goal", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:goal_id/comments", "params": [ { "name": "goal_id", "value": "", "type": "path", "description": "GoalId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on a goal", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:goal_id/comments", "params": [ { "name": "goal_id", "value": "", "type": "path", "description": "GoalId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on a release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:release_id/comments", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on a release", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:release_id/comments", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on a release phase", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/release_phases/:release_phase_id/comments", "params": [ { "name": "release_phase_id", "value": "", "type": "path", "description": "ReleasePhaseId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on a release phase", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/release_phases/:release_phase_id/comments", "params": [ { "name": "release_phase_id", "value": "", "type": "path", "description": "ReleasePhaseId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments on a to-do", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/tasks/:task_id/comments", "params": [ { "name": "task_id", "value": "", "type": "path", "description": "TaskId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Create a comment on a to-do", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/tasks/:task_id/comments", "params": [ { "name": "task_id", "value": "", "type": "path", "description": "TaskId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Get a specific comment", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/comments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Update a comment", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/comments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "Delete a comment", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/comments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" }, { "info": { "name": "List comments in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:project_id/comments", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "ProjectId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_commen" } ] }, { "info": { "name": "Competitors", "type": "folder" }, "items": [ { "info": { "name": "List competitors in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/competitors", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List competitors in a product" }, { "info": { "name": "Create a competitor", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/competitors", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a competitor" }, { "info": { "name": "Get a specific competitor", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/competitors/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific competitor" }, { "info": { "name": "Update a competitor", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/competitors/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a competitor" }, { "info": { "name": "Delete a competitor", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/competitors/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a competitor" } ] }, { "info": { "name": "Creative briefs", "type": "folder" }, "items": [ { "info": { "name": "List creative briefs in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/creative_briefs", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List creative briefs in a product" }, { "info": { "name": "Create a creative brief", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/creative_briefs", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a creative brief" }, { "info": { "name": "Get a specific creative_brief", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/creative_briefs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific creative_brief" }, { "info": { "name": "Update a creative brief", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/creative_briefs/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a creative brief" }, { "info": { "name": "Delete a creative brief", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/creative_briefs/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a creative brief" } ] }, { "info": { "name": "Custom fields", "type": "folder" }, "items": [ { "info": { "name": "List all custom fields", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_field_definitions", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom fields are defined by record type, and are shared\nacross all workspaces across the account. Fields must be\nadded to a layout before they will appear on a record.\n\nFor custom fields that include options, (e.g. tags, choice\nlists), you can also load the list of all available options." }, { "info": { "name": "List options for a custom field", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_field_definitions/:custom_field_definition_id/options", "params": [ { "name": "custom_field_definition_id", "value": "", "type": "path", "description": "CustomFieldDefinitionId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom fields are defined by record type, and are shared\nacross all workspaces across the account. Fields must be\nadded to a layout before they will appear on a record.\n\nFor custom fields that include options, (e.g. tags, choice\nlists), you can also load the list of all available options." } ] }, { "info": { "name": "Custom field options", "type": "folder" }, "items": [ { "info": { "name": "List all custom fields", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_field_definitions/:custom_field_definition_id/custom_field_options", "params": [ { "name": "custom_field_definition_id", "value": "", "type": "path", "description": "CustomFieldDefinitionId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all custom fields" }, { "info": { "name": "Create a custom field option", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_field_definitions/:custom_field_definition_id/custom_field_options", "params": [ { "name": "custom_field_definition_id", "value": "", "type": "path", "description": "CustomFieldDefinitionId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a custom field option" }, { "info": { "name": "Update a custom field option", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_field_definitions/:custom_field_definition_id/custom_field_options/:id", "params": [ { "name": "custom_field_definition_id", "value": "", "type": "path", "description": "CustomFieldDefinitionId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a custom field option" }, { "info": { "name": "Delete a custom field option", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_field_definitions/:custom_field_definition_id/custom_field_options/:id", "params": [ { "name": "custom_field_definition_id", "value": "", "type": "path", "description": "CustomFieldDefinitionId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a custom field option" } ] }, { "info": { "name": "Products", "type": "folder" }, "items": [ { "info": { "name": "Get a specific product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific product" }, { "info": { "name": "List products in the account", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products", "params": [ { "name": "include_teams", "value": "true", "type": "query" }, { "name": "with_idea_portals", "value": "true", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List products in the account" }, { "info": { "name": "Create a product", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a product" } ] }, { "info": { "name": "Custom table record links", "type": "folder" }, "items": [ { "info": { "name": "Create a custom table record link associated with a product", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_l" }, { "info": { "name": "Create a custom table record link associated with a release", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "*[Custom Tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.*" }, { "info": { "name": "Create a custom table record link associated with a feature", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_l" }, { "info": { "name": "Create a custom table record link associated with a requirement", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_l" }, { "info": { "name": "Create a custom table record link associated with an idea", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_l" }, { "info": { "name": "Create a custom table record link associated with an initiative", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_l" }, { "info": { "name": "Create a custom table record link associated with a goal", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_l" }, { "info": { "name": "Link custom table records to another custom table record", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_object_records/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_l" } ] }, { "info": { "name": "Releases", "type": "folder" }, "items": [ { "info": { "name": "Get a specific release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific release" }, { "info": { "name": "List releases in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/releases", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List releases in a product" }, { "info": { "name": "Create a release", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/releases", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a release" }, { "info": { "name": "List releases associated with a goal", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:goal_id/releases", "params": [ { "name": "goal_id", "value": "", "type": "path", "description": "GoalId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List releases associated with a goal" }, { "info": { "name": "List releases associated with an initiative", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/releases", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List releases associated with an initiative" }, { "info": { "name": "List releases under a roll-up release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:release_id/releases", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List releases under a roll-up release" }, { "info": { "name": "List releases under a roll-up release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/roll_up_releases/:release_id/releases", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List releases under a roll-up release" }, { "info": { "name": "Duplicate a release", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:id/duplicate", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Duplicate a release" }, { "info": { "name": "Update a release", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/releases/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a release" }, { "info": { "name": "Delete a release", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/releases/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a release" } ] }, { "info": { "name": "Features", "type": "folder" }, "items": [ { "info": { "name": "Get a specific feature", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modi" }, { "info": { "name": "Delete a feature", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modi" }, { "info": { "name": "List features in a release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:release_id/features", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modi" }, { "info": { "name": "Create a feature", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:release_id/features", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new feature in a release with full details including assignee and description" }, { "info": { "name": "List features", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a paginated list of all features across the account with optional filtering and field selection" }, { "info": { "name": "List features in an epic", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:epic_id/features", "params": [ { "name": "epic_id", "value": "", "type": "path", "description": "EpicId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modi" }, { "info": { "name": "List features in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/features", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modi" }, { "info": { "name": "List features associated with a goal", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:goal_id/features", "params": [ { "name": "goal_id", "value": "", "type": "path", "description": "GoalId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modi" }, { "info": { "name": "List features associated with an initiative", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/features", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modi" }, { "info": { "name": "Convert a feature to an epic", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:id/convert_to_epic", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Converts an existing feature into an epic, maintaining all relationships and data" } ] }, { "info": { "name": "Requirements", "type": "folder" }, "items": [ { "info": { "name": "Get a specific requirement", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific requirement" }, { "info": { "name": "Delete a requirement", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a requirement" }, { "info": { "name": "List requirements for a feature", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/requirements", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" }, { "name": "updated_since", "value": "2019-01-01T00:00:00Z", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List requirements for a feature" }, { "info": { "name": "Create a requirement", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/requirements", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a requirement" }, { "info": { "name": "Convert a requirement to a feature", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/:id/convert_to_feature", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Convert a requirement to a feature" } ] }, { "info": { "name": "Ideas", "type": "folder" }, "items": [ { "info": { "name": "Get a specific idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body." }, { "info": { "name": "Delete an idea", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body." }, { "info": { "name": "List ideas for a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/ideas", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body." }, { "info": { "name": "Create an idea", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/ideas", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new idea with basic details including initial vote count" }, { "info": { "name": "List ideas", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body." }, { "info": { "name": "Get a specific idea with plain text body", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:id?fields=description,plain_text_body", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" }, { "name": "fields", "value": "description,plain_text_body", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body." }, { "info": { "name": "List ideas related to a particular term", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/related", "params": [ { "name": "q", "value": "ideas are a dime a dozen", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body." }, { "info": { "name": "Promote an idea", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:id/promote", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body." } ] }, { "info": { "name": "Initiatives", "type": "folder" }, "items": [ { "info": { "name": "Get a specific initiative", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific initiative" }, { "info": { "name": "List initiatives in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/initiatives", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List initiatives in a product" }, { "info": { "name": "Create an initiative", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/initiatives", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an initiative" }, { "info": { "name": "List initiatives", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List initiatives" }, { "info": { "name": "List initiatives associated with a goal", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:goal_id/initiatives", "params": [ { "name": "goal_id", "value": "", "type": "path", "description": "GoalId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List initiatives associated with a goal" }, { "info": { "name": "Update an initiative", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/initiatives/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an initiative" }, { "info": { "name": "Delete an initiative", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/initiatives/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an initiative" } ] }, { "info": { "name": "Goals", "type": "folder" }, "items": [ { "info": { "name": "Get a specific goal", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific goal" }, { "info": { "name": "List goals in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/goals", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List goals in a product" }, { "info": { "name": "Create a goal", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/goals", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a goal" }, { "info": { "name": "List goals", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List goals" }, { "info": { "name": "List goals associated with an initiative", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/goals", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List goals associated with an initiative" }, { "info": { "name": "Update a goal", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/goals/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a goal" }, { "info": { "name": "Delete a goal", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/goals/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a goal" } ] }, { "info": { "name": "Custom table records", "type": "folder" }, "items": [ { "info": { "name": "Get a specific custom table record", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_object_records/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom tables have a different set of records for each product.\nThis means that if you want to\n[create one](/api/resources/custom_table_records/create_a_custom_table_record)\nor\n[list them](/api/resources/custom_table_records/list_records_in_a_custom_table_for_a_product)\nyou must scope them to a product.\n\nOnce you have the ID of a specific custom table record, you can\n[get](/api/resources/custom_table_records/get_a_specific_custom_table_record),\n[modify](/api/resources/custom_table_records/update" }, { "info": { "name": "Delete a custom table record", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/custom_object_records/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom tables have a different set of records for each product.\nThis means that if you want to\n[create one](/api/resources/custom_table_records/create_a_custom_table_record)\nor\n[list them](/api/resources/custom_table_records/list_records_in_a_custom_table_for_a_product)\nyou must scope them to a product.\n\nOnce you have the ID of a specific custom table record, you can\n[get](/api/resources/custom_table_records/get_a_specific_custom_table_record),\n[modify](/api/resources/custom_table_records/update" }, { "info": { "name": "List records in a custom table for a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/custom_objects/:key/records", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "key", "value": "", "type": "path", "description": "Key identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom tables have a different set of records for each product.\nThis means that if you want to\n[create one](/api/resources/custom_table_records/create_a_custom_table_record)\nor\n[list them](/api/resources/custom_table_records/list_records_in_a_custom_table_for_a_product)\nyou must scope them to a product.\n\nOnce you have the ID of a specific custom table record, you can\n[get](/api/resources/custom_table_records/get_a_specific_custom_table_record),\n[modify](/api/resources/custom_table_records/update" }, { "info": { "name": "Create a custom table record", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/custom_objects/:key/records", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "key", "value": "", "type": "path", "description": "Key identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom tables have a different set of records for each product.\nThis means that if you want to\n[create one](/api/resources/custom_table_records/create_a_custom_table_record)\nor\n[list them](/api/resources/custom_table_records/list_records_in_a_custom_table_for_a_product)\nyou must scope them to a product.\n\nOnce you have the ID of a specific custom table record, you can\n[get](/api/resources/custom_table_records/get_a_specific_custom_table_record),\n[modify](/api/resources/custom_table_records/update" } ] }, { "info": { "name": "Custom pivots", "type": "folder" }, "items": [ { "info": { "name": "Get the list view of a saved report", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/bookmarks/custom_pivots/:report_id", "params": [ { "name": "report_id", "value": "", "type": "path", "description": "ReportId identifier" }, { "name": "view", "value": "list", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The list view responds with a JSON object with three attributes: pagination, columns, and rows.\n\nThe columns attribute is an array of objects that give detailed information\nabout the columns of the list. The objects include the name of the table, the field, and\na human readable title attribute.\n\nThe rows attribute is an of array of arrays. Each object within the inner array contains the value\nof that for a specific column. Each object contains attributes for various representations of the\ndata. " } ] }, { "info": { "name": "Deletions", "type": "folder" }, "items": [ { "info": { "name": "List contents of recycle bin", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/deletions", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The recycle bin contains recently deleted workspaces, teams, and records. It is possible to restore items up to 7 days after they have been deleted." }, { "info": { "name": "restore a specific record", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/deletions/:id/restore", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The recycle bin contains recently deleted workspaces, teams, and records. It is possible to restore items up to 7 days after they have been deleted." } ] }, { "info": { "name": "Epics", "type": "folder" }, "items": [ { "info": { "name": "List epics", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "List epics in a release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:release_id/epics", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "Create an epic", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:release_id/epics", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "List epics in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/epics", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "Create an epic in the default release", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/epics", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "List epics associated with a goal", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:goal_id/epics", "params": [ { "name": "goal_id", "value": "", "type": "path", "description": "GoalId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "List epics associated with an initiative", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/epics", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "Get a specific epic", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "Update an epic", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" }, { "info": { "name": "Delete an epic", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources" } ] }, { "info": { "name": "Capacity estimate values", "type": "folder" }, "items": [ { "info": { "name": "List estimate values for a capacity investment", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/capacity_investments/:id/estimate_values", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List estimate values for a capacity investment" }, { "info": { "name": "Create estimate values for a capacity investment", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/capacity_investments/:id/estimate_values", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Estimate value objects should include the following keys: `team_id`, `period_start`, and `total`. This endpoint uses an \"upsert\" flow, updating existing records, or creating new ones if they do not exist. Returns all updated and destroyed estimate values, including computed sums and ignored values." }, { "info": { "name": "Update an estimate value", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/estimate_values/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all updated estimate values, including computed sums and ignored values." }, { "info": { "name": "Delete an estimate value", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/estimate_values/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all updated and destroyed estimate values, including computed sums and ignored values." } ] }, { "info": { "name": "Idea categories", "type": "folder" }, "items": [ { "info": { "name": "List idea categories in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/idea_categories", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List idea categories in a product" } ] }, { "info": { "name": "Idea comments", "type": "folder" }, "items": [ { "info": { "name": "List idea comments for an idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/idea_comments", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Idea comments can appear in ideas portals.\nTo reply to an idea_comment, specify the parent_idea_comment_id. Its visibility\nwill come from its parent idea comment and cannot be overridden." }, { "info": { "name": "Create an idea comment for an idea", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/idea_comments", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Idea comments can appear in ideas portals.\nTo reply to an idea_comment, specify the parent_idea_comment_id. Its visibility\nwill come from its parent idea comment and cannot be overridden." }, { "info": { "name": "Mark an idea comment as spam", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_comments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Idea comments can appear in ideas portals.\nTo reply to an idea_comment, specify the parent_idea_comment_id. Its visibility\nwill come from its parent idea comment and cannot be overridden." }, { "info": { "name": "Delete an idea comment", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/idea_comments/:id", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Idea comments can appear in ideas portals.\nTo reply to an idea_comment, specify the parent_idea_comment_id. Its visibility\nwill come from its parent idea comment and cannot be overridden." } ] }, { "info": { "name": "Idea votes", "type": "folder" }, "items": [ { "info": { "name": "List votes for an idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/endorsements", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "fields", "value": "*,associated_idea_organizations", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints." }, { "info": { "name": "Create an idea vote", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/endorsements", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints." }, { "info": { "name": "Create additional idea votes", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/endorsements?multiple_endorsements=true", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "multiple_endorsements", "value": "true", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an additional vote for a user who has already voted on the idea. Only permitted for an ideas portal where users are allowed multiple votes on the same idea." }, { "info": { "name": "Create an idea vote for a user, using the vote limits of an idea portal", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/endorsements?idea_portal_id=:idea_portal_id", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" }, { "name": "idea_portal_id", "value": "747493361", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints." }, { "info": { "name": "List votes for an account", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/endorsements", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints." }, { "info": { "name": "List only proxy votes for an idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/endorsements?proxy=true", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "proxy", "value": "true", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Only returns votes that have an associated organization (proxy votes)." }, { "info": { "name": "Get a specific vote for an idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/endorsements/:id", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints." }, { "info": { "name": "Update an idea vote", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/endorsements/:id", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints." }, { "info": { "name": "Delete an idea vote", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/endorsements/:id", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints." } ] }, { "info": { "name": "Idea organizations", "type": "folder" }, "items": [ { "info": { "name": "List idea organizations", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_organizations", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List idea organizations" }, { "info": { "name": "Create an idea organization", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_organizations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an idea organization" }, { "info": { "name": "Get a specific organization", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_organizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific organization" }, { "info": { "name": "Update organization", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_organizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update organization" }, { "info": { "name": "Delete organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_organizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete organization" } ] }, { "info": { "name": "Idea Portals", "type": "folder" }, "items": [ { "info": { "name": "List idea portals in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/idea_portals", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List idea portals in a product" }, { "info": { "name": "List all idea portals in an account", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals", "params": [ { "name": "page", "value": "1", "type": "query" }, { "name": "per_page", "value": "10", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all idea portals in an account" } ] }, { "info": { "name": "Idea subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List subscriptions for an idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/subscriptions", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List subscriptions for an idea" }, { "info": { "name": "Create an idea subscription", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/subscriptions", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an idea subscription" }, { "info": { "name": "Get a specific subscription for an idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/subscriptions/:id", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific subscription for an idea" }, { "info": { "name": "Delete an idea subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/subscriptions/:id", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an idea subscription" } ] }, { "info": { "name": "Idea users", "type": "folder" }, "items": [ { "info": { "name": "List idea users for an account", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_users", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List idea users for an account" }, { "info": { "name": "Create a idea user", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a idea user" }, { "info": { "name": "Get a specific idea user", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific idea user" }, { "info": { "name": "Update an idea user", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an idea user" }, { "info": { "name": "Delete an idea user", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an idea user" } ] }, { "info": { "name": "Identity providers", "type": "folder" }, "items": [ { "info": { "name": "List active identity providers that can be used for SSO", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/identity_providers", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List active identity providers that can be used for SSO" }, { "info": { "name": "Get a specific identity provider", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/identity_providers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific identity provider" } ] }, { "info": { "name": "Integration changes", "type": "folder" }, "items": [ { "info": { "name": "Send a record to an integration", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/integration_changes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint mimicks the \"Send to integration\" button on a record in the UI." } ] }, { "info": { "name": "Integration fields", "type": "folder" }, "items": [ { "info": { "name": "Create an integration field for a feature by integration ID", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/integrations/:integration_id/fields", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" }, { "name": "integration_id", "value": "", "type": "path", "description": "IntegrationId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an integration field for a feature by integration ID" }, { "info": { "name": "Create an integration field for a feature by service name", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/integrations/:service_name/fields", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" }, { "name": "service_name", "value": "", "type": "path", "description": "ServiceName identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "DEPRECATED: provide :integration_id rather than :service_name to identify the integration." }, { "info": { "name": "Create an integration field for a epic by integration ID", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:epic_id/integrations/:integration_id/fields", "params": [ { "name": "epic_id", "value": "", "type": "path", "description": "EpicId identifier" }, { "name": "integration_id", "value": "", "type": "path", "description": "IntegrationId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an integration field for a epic by integration ID" }, { "info": { "name": "Create an integration field for an idea vote", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_endorsements/:idea_endorsement_id/integrations/:integration_id/fields", "params": [ { "name": "idea_endorsement_id", "value": "", "type": "path", "description": "IdeaEndorsementId identifier" }, { "name": "integration_id", "value": "", "type": "path", "description": "IntegrationId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an integration field for an idea vote" }, { "info": { "name": "Create an integration field for an idea by integration ID", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/integrations/:integration_id/fields", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" }, { "name": "integration_id", "value": "", "type": "path", "description": "IntegrationId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an integration field for an idea by integration ID" }, { "info": { "name": "Get a specific integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/integrations/:integration_id/fields/:field_name", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" }, { "name": "integration_id", "value": "", "type": "path", "description": "IntegrationId identifier" }, { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific integration field value" }, { "info": { "name": "List records with an associated integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/integrations/:integration_id/fields/:field_name/value/:field_value", "params": [ { "name": "integration_id", "value": "", "type": "path", "description": "IntegrationId identifier" }, { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" }, { "name": "field_value", "value": "", "type": "path", "description": "FieldValue identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Possible records are releases, initiatives, features, epics, requirements, ideas or idea votes." }, { "info": { "name": "List releases with an associated integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/fields/:field_name/value/:field_value", "params": [ { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" }, { "name": "field_value", "value": "", "type": "path", "description": "FieldValue identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List releases with an associated integration field value" }, { "info": { "name": "List initiatives with an associated integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/fields/:field_name/value/:field_value", "params": [ { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" }, { "name": "field_value", "value": "", "type": "path", "description": "FieldValue identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List initiatives with an associated integration field value" }, { "info": { "name": "List features with an associated integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/fields/:field_name/value/:field_value", "params": [ { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" }, { "name": "field_value", "value": "", "type": "path", "description": "FieldValue identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List features with an associated integration field value" }, { "info": { "name": "List epics with an associated integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/fields/:field_name/value/:field_value", "params": [ { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" }, { "name": "field_value", "value": "", "type": "path", "description": "FieldValue identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List epics with an associated integration field value" }, { "info": { "name": "List requirements with an associated integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/fields/:field_name/value/:field_value", "params": [ { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" }, { "name": "field_value", "value": "", "type": "path", "description": "FieldValue identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List requirements with an associated integration field value" }, { "info": { "name": "List ideas with an associated integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/fields/:field_name/value/:field_value", "params": [ { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" }, { "name": "field_value", "value": "", "type": "path", "description": "FieldValue identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List ideas with an associated integration field value" }, { "info": { "name": "List idea votes with an associated integration field value", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_endorsements/fields/:field_name/value/:field_value", "params": [ { "name": "field_name", "value": "", "type": "path", "description": "FieldName identifier" }, { "name": "field_value", "value": "", "type": "path", "description": "FieldValue identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List idea votes with an associated integration field value" }, { "info": { "name": "Delete an integration field", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/integration_fields/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an integration field" } ] }, { "info": { "name": "Integrations", "type": "folder" }, "items": [ { "info": { "name": "List integrations for an account", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/integrations", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List integrations for an account" }, { "info": { "name": "Create an integration for an account", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/integrations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an integration for an account" }, { "info": { "name": "List integrations for a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/integrations", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List integrations for a product" }, { "info": { "name": "Create an integration for a product", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/integrations", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an integration for a product" }, { "info": { "name": "Get a specific integration", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/integrations/:integration_id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "integration_id", "value": "", "type": "path", "description": "IntegrationId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific integration" }, { "info": { "name": "Enable integration", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/integrations/:integration_id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "integration_id", "value": "", "type": "path", "description": "IntegrationId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enable integration" }, { "info": { "name": "Get a specific integration by service name", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/integrations/:service_name", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "service_name", "value": "", "type": "path", "description": "ServiceName identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "DEPRECATED: provide :integration_id rather than :service_name to identify the integration." } ] }, { "info": { "name": "Key results", "type": "folder" }, "items": [ { "info": { "name": "List key results for a goal", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:goal_id/key_results", "params": [ { "name": "goal_id", "value": "", "type": "path", "description": "GoalId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List key results for a goal" }, { "info": { "name": "Create a key result", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/goals/:goal_id/key_results", "params": [ { "name": "goal_id", "value": "", "type": "path", "description": "GoalId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a key result" }, { "info": { "name": "Get a specific key result", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/key_results/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific key result" }, { "info": { "name": "Update a key result", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/key_results/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a key result" }, { "info": { "name": "Delete a key result", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/key_results/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a key result" } ] }, { "info": { "name": "Roll up releases", "type": "folder" }, "items": [ { "info": { "name": "Get a specific roll up release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/roll_up_releases/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific roll up release" }, { "info": { "name": "Update a roll up release", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/roll_up_releases/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a roll up release" }, { "info": { "name": "List roll up releases in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/roll_up_releases", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List roll up releases in a product" }, { "info": { "name": "Creates a roll up release", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/roll_up_releases", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a roll up release" } ] }, { "info": { "name": "Me", "type": "folder" }, "items": [ { "info": { "name": "Get the current user profile", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/me", "params": [ { "name": "include", "value": "#", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves current user information including account memberships and basic profile data" }, { "info": { "name": "List records assigned to the current user", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/me/assigned", "params": [ { "name": "record_type", "value": "InvalidType", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The Me API provides access to current user information, assigned records, and pending tasks.\nThis endpoint serves as the primary interface for user-specific data and personal workspace functionality.\n\n**Core Functionality**:\n- **User Profile** - Current user information including accounts and permissions\n- **Assigned Records** - All records assigned to the current user across different types\n- **Task Management** - Pending tasks assigned to the current user\n\n**User Context**:\n- All endpoints ret" }, { "info": { "name": "List pending tasks assigned to the current user", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/me/tasks", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The Me API provides access to current user information, assigned records, and pending tasks.\nThis endpoint serves as the primary interface for user-specific data and personal workspace functionality.\n\n**Core Functionality**:\n- **User Profile** - Current user information including accounts and permissions\n- **Assigned Records** - All records assigned to the current user across different types\n- **Task Management** - Pending tasks assigned to the current user\n\n**User Context**:\n- All endpoints ret" } ] }, { "info": { "name": "Notes", "type": "folder" }, "items": [ { "info": { "name": "List notes for a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/pages", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints." }, { "info": { "name": "Create a note", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/pages", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints." }, { "info": { "name": "Get a specific note", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/pages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints." }, { "info": { "name": "Update a note", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/pages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints." }, { "info": { "name": "Delete a note", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/pages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints." } ] }, { "info": { "name": "Paid Seat Groups", "type": "folder" }, "items": [ { "info": { "name": "List the administered paid seat groups", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/paid_seat_groups", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List the administered paid seat groups" }, { "info": { "name": "Updates the paid seat group", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/paid_seat_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the paid seat group" }, { "info": { "name": "Adds the user to the paid seat group", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/paid_seat_groups/:id/modify_user", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds the user to the paid seat group" } ] }, { "info": { "name": "Personas", "type": "folder" }, "items": [ { "info": { "name": "List personas in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/personas", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List personas in a product" }, { "info": { "name": "Create a persona", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/personas", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a persona" }, { "info": { "name": "Get a specific persona", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/personas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific persona" }, { "info": { "name": "Update a persona", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/personas/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a persona" }, { "info": { "name": "Delete a persona", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/personas/:id", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a persona" } ] }, { "info": { "name": "Ideas portal user subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List a portal user's preferences for the portal summary email", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals/:idea_portal_id/portal_users/:portal_user_id/portal_user_subscriptions", "params": [ { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" }, { "name": "portal_user_id", "value": "", "type": "path", "description": "PortalUserId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List a portal user's preferences for the portal summary email" }, { "info": { "name": "Set a portal user's preferences to specific project and category updates", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals/:idea_portal_id/portal_users/:portal_user_id/portal_user_subscriptions", "params": [ { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" }, { "name": "portal_user_id", "value": "", "type": "path", "description": "PortalUserId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set a portal user's preferences to specific project and category updates" }, { "info": { "name": "Subscribe a portal user to updates from all projects and categories", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals/:idea_portal_id/portal_users/:portal_user_id/portal_user_subscriptions/subscribe_to_all", "params": [ { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" }, { "name": "portal_user_id", "value": "", "type": "path", "description": "PortalUserId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Subscribe a portal user to updates from all projects and categories" } ] }, { "info": { "name": "Ideas portal users", "type": "folder" }, "items": [ { "info": { "name": "List portal users for an ideas portal", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals/:idea_portal_id/portal_users", "params": [ { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List portal users for an ideas portal" }, { "info": { "name": "Create a portal user", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals/:idea_portal_id/portal_users", "params": [ { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a portal user" }, { "info": { "name": "Get a specific portal user", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals/:idea_portal_id/portal_users/:id", "params": [ { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific portal user" }, { "info": { "name": "Update a portal user", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals/:idea_portal_id/portal_users/:id", "params": [ { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a portal user" }, { "info": { "name": "Delete a portal user", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/idea_portals/:idea_portal_id/portal_users/:id", "params": [ { "name": "idea_portal_id", "value": "", "type": "path", "description": "IdeaPortalId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a portal user" } ] }, { "info": { "name": "Record links", "type": "folder" }, "items": [ { "info": { "name": "List record links for a feature", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:id/record_links", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" }, { "name": "parent_and_child_links", "value": "true", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List record links for a feature" }, { "info": { "name": "Get a specific record link", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/record_links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific record link" }, { "info": { "name": "Delete a record link", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/record_links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a record link" }, { "info": { "name": "Create a record link for a feature", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/:record_type/:id/record_links", "params": [ { "name": "record_type", "value": "", "type": "path", "description": "RecordType identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a record link for a feature" } ] }, { "info": { "name": "Release phases", "type": "folder" }, "items": [ { "info": { "name": "List release phases for a release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:id/release_phases", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List release phases for a release" }, { "info": { "name": "Get a specific release phase", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/release_phases/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific release phase" }, { "info": { "name": "Update a release phase", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/release_phases/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a release phase" }, { "info": { "name": "Delete a release phase", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/release_phases/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a release phase" }, { "info": { "name": "List release phases in the account", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/release_phases", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List release phases in the account" }, { "info": { "name": "Create a release phase", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/release_phases", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a release phase" } ] }, { "info": { "name": "Schedulable changes", "type": "folder" }, "items": [ { "info": { "name": "List schedulable changes", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/schedulable_changes", "params": [ { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List schedulable changes" }, { "info": { "name": "Create a schedulable change", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/schedulable_changes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a schedulable change" }, { "info": { "name": "Update a schedulable change", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/schedulable_changes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a schedulable change" }, { "info": { "name": "Delete a schedulable change", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/schedulable_changes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a schedulable change" }, { "info": { "name": "Update a scheduled change's team memberships", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/schedulable_changes/:schedulable_change_id/update_team_memberships", "params": [ { "name": "schedulable_change_id", "value": "", "type": "path", "description": "SchedulableChangeId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds, updates, or removes users via a scheduled change using the Team Membership relation. The schedulable change must be in the future" } ] }, { "info": { "name": "Schedules", "type": "folder" }, "items": [ { "info": { "name": "List schedules", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/schedules", "params": [ { "name": "fields", "value": "name,hours_per_day,story_points_per_day,velocity,monday,tuesday,wednesday,thursday,friday,saturday,sunday", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves schedules for capacity planning, showing working hours, velocity, and weekly patterns" } ] }, { "info": { "name": "Custom Layouts", "type": "folder" }, "items": [ { "info": { "name": "List all custom layouts", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/screen_definitions", "params": [ { "name": "page", "value": "1", "type": "query" }, { "name": "per_page", "value": "50", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom layouts in Aha! Roadmaps help you define the information that you want your teammates to see at two important times: when they create a record and when they view a record's details. You must be a configuration administrator to view custom layouts on your account through the API.\n\nFor more information about custom layouts, consult our support documentation: https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-layouts" }, { "info": { "name": "Get a custom layout by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/screen_definitions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom layouts in Aha! Roadmaps help you define the information that you want your teammates to see at two important times: when they create a record and when they view a record's details. You must be a configuration administrator to view custom layouts on your account through the API.\n\nFor more information about custom layouts, consult our support documentation: https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-layouts" } ] }, { "info": { "name": "Strategic models", "type": "folder" }, "items": [ { "info": { "name": "List strategic models", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/strategy_models", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List strategic models" }, { "info": { "name": "Get a specific strategic model", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/strategy_models/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific strategic model" } ] }, { "info": { "name": "Strategic positionings", "type": "folder" }, "items": [ { "info": { "name": "List strategic positionings", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/strategy_positions", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List strategic positionings" }, { "info": { "name": "Get a specific strategic positioning", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/strategy_positions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific strategic positioning" } ] }, { "info": { "name": "Strategic visions", "type": "folder" }, "items": [ { "info": { "name": "List strategic visions", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/strategy_visions", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List strategic visions" }, { "info": { "name": "Get a specific strategic vision", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/strategy_visions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific strategic vision" } ] }, { "info": { "name": "To-dos", "type": "folder" }, "items": [ { "info": { "name": "List to-dos", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/tasks", "params": [ { "name": "updated_since", "value": "2019-01-01T00:00:00Z", "type": "query" }, { "name": "type", "value": "Approval", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List to-dos" }, { "info": { "name": "Create a task", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/tasks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a task" }, { "info": { "name": "List to-dos associated with a feature", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/tasks", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List to-dos associated with a feature" }, { "info": { "name": "List to-dos associated with an epic", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/epics/:epic_id/tasks", "params": [ { "name": "epic_id", "value": "", "type": "path", "description": "EpicId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List to-dos associated with an epic" }, { "info": { "name": "List to-dos associated with a release", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/releases/:release_id/tasks", "params": [ { "name": "release_id", "value": "", "type": "path", "description": "ReleaseId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List to-dos associated with a release" }, { "info": { "name": "List to-dos associated with an idea", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/ideas/:idea_id/tasks", "params": [ { "name": "idea_id", "value": "", "type": "path", "description": "IdeaId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List to-dos associated with an idea" }, { "info": { "name": "List to-dos associated with a requirement", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/:requirement_id/tasks", "params": [ { "name": "requirement_id", "value": "", "type": "path", "description": "RequirementId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List to-dos associated with a requirement" }, { "info": { "name": "List to-dos associated with a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/tasks", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List to-dos associated with a product" }, { "info": { "name": "List to-dos assigned to a user", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:user_id/tasks", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "UserId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List to-dos assigned to a user" }, { "info": { "name": "Get a specific to-do", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific to-do" }, { "info": { "name": "Update a to-do", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a to-do" }, { "info": { "name": "Delete a to-do", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a to-do" } ] }, { "info": { "name": "Team members", "type": "folder" }, "items": [ { "info": { "name": "List virtual team members", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/team_members", "params": [ { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Manage virtual users used in capacity planning" }, { "info": { "name": "Create a virtual user", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/team_members", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Manage virtual users used in capacity planning" }, { "info": { "name": "Delete a virtual team member", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/team_members/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Manage virtual users used in capacity planning" } ] }, { "info": { "name": "Team memberships", "type": "folder" }, "items": [ { "info": { "name": "List team memberships for a team", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/teams/:team_id/team_memberships", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "TeamId identifier" }, { "name": "fields", "value": "team_member,team,created_at", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Team memberships for capacity planning teams. Users can be either Aha! users or virtual users" }, { "info": { "name": "Add user to a team", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/teams/:team_id/team_memberships", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "TeamId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Team memberships for capacity planning teams. Users can be either Aha! users or virtual users" }, { "info": { "name": "Remove a user from a team", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/teams/:team_id/team_memberships/:id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "TeamId identifier" }, { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Team memberships for capacity planning teams. Users can be either Aha! users or virtual users" } ] }, { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "List teams", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/teams", "params": [ { "name": "fields", "value": "name,team_members_count,automatically_calculate_team_members_count,capacity,hourly_rate,color,start_date,end_date,project,schedule,custom_fields,team_members", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List teams" }, { "info": { "name": "Create a team", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/teams", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a team" }, { "info": { "name": "List teams in a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/teams", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List teams in a product" }, { "info": { "name": "Create a team associated with a product", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/teams", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a team associated with a product" }, { "info": { "name": "Get a specific team", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/teams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" }, { "name": "{}", "value": "null", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific team" }, { "info": { "name": "Update a team's product", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/teams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a team's product" }, { "info": { "name": "Delete a team", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/teams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a team" } ] }, { "info": { "name": "Time tracking events", "type": "folder" }, "items": [ { "info": { "name": "Create a time tracking event for a feature with remaining estimate", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/features/:feature_id/time_tracking_events", "params": [ { "name": "feature_id", "value": "", "type": "path", "description": "FeatureId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a time tracking event for a feature with remaining estimate" }, { "info": { "name": "Create a time tracking event for a requirement", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/requirements/:requirement_id/time_tracking_events", "params": [ { "name": "requirement_id", "value": "", "type": "path", "description": "RequirementId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a time tracking event for a requirement" }, { "info": { "name": "Create a time tracking event for an initiative", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/initiatives/:initiative_id/time_tracking_events", "params": [ { "name": "initiative_id", "value": "", "type": "path", "description": "InitiativeId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a time tracking event for an initiative" }, { "info": { "name": "Delete a time tracking event", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/time_tracking_events/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a time tracking event" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "List users associated with a product", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/users", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List users associated with a product" }, { "info": { "name": "Create a user", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/users", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a user" }, { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "**[Custom roles](https://www.aha.io/support/roadmaps/account/billing-and-users/custom-user-permission-roles) are an Enterprise+ exclusive feature.**" }, { "info": { "name": "Get a specific user", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific user" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PUT", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a user" }, { "info": { "name": "List a user's product roles", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:id/product_roles", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List a user's product roles" }, { "info": { "name": "Update a user's product roles", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:id/product_roles", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a user's product roles" }, { "info": { "name": "Delete a user's product role", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:id/product_roles/:product_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" }, { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a user's product role" }, { "info": { "name": "List a user's custom roles", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:id/user_roles", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List a user's custom roles" }, { "info": { "name": "Update a user's custom roles", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:id/user_roles", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a user's custom roles" }, { "info": { "name": "Delete a user's custom role", "type": "http" }, "http": { "method": "DELETE", "url": "https://{account-domain}.aha.io/api/v1/api/v1/users/:id/user_roles/:product_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" }, { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a user's custom role" } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Validate webhook endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/webhooks/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Token identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint allows integration services to validate that the webhook URL \nis accessible and properly configured without triggering actual webhook processing.\nUseful for testing webhook connectivity during integration setup." }, { "info": { "name": "Process a Jira webhook", "type": "http" }, "http": { "method": "POST", "url": "https://{account-domain}.aha.io/api/v1/api/v1/webhooks/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Token identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Receives and processes a webhook from Jira when an issue is updated.\n\nTypical Jira webhook payload includes:\n- issue: { id: \"12345\", key: \"PROJ-123\", fields: { summary: \"Feature name\", status: { name: \"In Progress\" } } }\n- webhookEvent: \"jira:issue_updated\"\n- timestamp: \"2019-01-01T00:00:00Z\"" } ] }, { "info": { "name": "Workflows", "type": "folder" }, "items": [ { "info": { "name": "List workflows", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/products/:product_id/workflows", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "ProductId identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List workflows" }, { "info": { "name": "Get a specific workflow", "type": "http" }, "http": { "method": "GET", "url": "https://{account-domain}.aha.io/api/v1/api/v1/workflows/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id identifier" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://{account-domain}.aha.io/oauth/authorize", "accessTokenUrl": "https://{account-domain}.aha.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific workflow" } ] } ], "bundled": true }