Workflows

Get a specific workflow

Changed on
get/workflows/{id}

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id identifier

Response

Successful operation

Example response

{
  "workflow": {
    "id": 80245244,
    "name": "Account product idea workflow",
    "statusable_type": "Idea",
    "transitions_only": false,
    "workflow_statuses": [
      {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6",
        "workflow_status_category": null
      },
      {
        "id": "349486678",
        "name": "Shipped",
        "position": 4,
        "complete": true,
        "color": "#ecdd8f",
        "workflow_status_category": {
          "id": "51383845",
          "name": "Shipped"
        }
      },
      {
        "id": "509459046",
        "name": "Done",
        "position": 3,
        "complete": true,
        "color": "#ecdd8f",
        "workflow_status_category": {
          "id": "935706688",
          "name": "Done"
        }
      },
      {
        "id": "1009437757",
        "name": "In progress",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f",
        "workflow_status_category": {
          "id": "112353881",
          "name": "In progress"
        }
      }
    ],
    "workflow_kinds": [
      {
        "id": "1809278",
        "name": "Improvement"
      },
      {
        "id": "787053401",
        "name": "New"
      }
    ]
  }
}

Changes

    • breaking

      the response property /// became nullable for the status

    • breaking

      the /// response's property type changed from object to null for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property /// to the response with the status