AHaha
Goals

Get a specific goal

Changed on
get/goals/{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

{
  "goals": [
    {
      "id": "111739083",
      "name": "Goal 5",
      "reference_num": "DEMOENT-G-5",
      "effort": 40,
      "value": 30,
      "color": "#bada55",
      "position": 5,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "product_id": "131414752",
      "progress": null,
      "progress_source": "progress_manual",
      "url": "https://company.aha.io/strategic_imperatives/DEMOENT-G-5",
      "resource": "https://company.aha.io/strategic_imperatives/DEMOENT-G-5",
      "description": {
        "id": "996214770",
        "body": "Description of project1_strategic_imperative5_archived_epoch",
        "notable_id": "111739083",
        "notable_type": "StrategicImperative",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "success_metric": {
        "name": "Metric 5",
        "description": {
          "id": "429990377",
          "body": "Description of project1_strategic_imperative5_archived_epoch_strategic_imperative_metric",
          "notable_id": "330165199",
          "notable_type": "StrategicImperativeMetric",
          "editor_version": 1,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "attachments": []
        },
        "workflow_status": {
          "id": "396368932",
          "name": "On Track",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f",
          "workflow_status_category": {
            "id": "112353881",
            "name": "In progress"
          }
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "https://company.aha.io/projects/PRJ1",
        "workspace_type": "product_workspace"
      },
      "time_frame": {
        "id": 834757622,
        "name": "2018"
      },
      "initiatives": [],
      "key_results": [],
      "comments_count": 0,
      "features": [],
      "releases": [],
      "custom_fields": []
    },
    {
      "id": "602095703",
      "name": "Goal 1",
      "reference_num": "DEMOENT-G-1",
      "effort": 10,
      "value": 70,
      "color": "#bada55",
      "position": 1,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "product_id": "131414752",
      "progress": null,
      "progress_source": "progress_manual",
      "url": "https://company.aha.io/strategic_imperatives/DEMOENT-G-1",
      "resource": "https://company.aha.io/strategic_imperatives/DEMOENT-G-1",
      "description": {
        "id": "166463080",
        "body": "Description of goal 1",
        "notable_id": "602095703",
        "notable_type": "StrategicImperative",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "success_metric": {
        "name": "Metric 1",
        "description": {
          "id": "546284368",
          "body": "Description of goal 1",
          "notable_id": "1060592970",
          "notable_type": "StrategicImperativeMetric",
          "editor_version": 1,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "attachments": []
        },
        "workflow_status": {
          "id": "396368932",
          "name": "On Track",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f",
          "workflow_status_category": {
            "id": "112353881",
            "name": "In progress"
          }
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "https://company.aha.io/projects/PRJ1",
        "workspace_type": "product_workspace"
      },
      "initiatives": [
        {
          "id": "423077122",
          "name": "Initiative 1",
          "reference_num": "PRJ1-S-1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "https://company.aha.io/initiatives/PRJ1-S-1",
          "resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-1",
          "description": {
            "id": "673273729",
            "body": "Description of initiative 1",
            "notable_id": "423077122",
            "notable_type": "Initiative",
            "editor_version": 1,
            "created_at": "2019-01-01T00:00:00.000Z",
            "updated_at": "2019-01-01T00:00:00.000Z",
            "attachments": []
          },
          "integration_fields": [
            {
              "id": "546711007",
              "name": "id",
              "value": "9913333",
              "integration_id": 186281709,
              "service_name": "jira",
              "created_at": "2019-01-01T00:00:00.000Z"
            },
            {
              "id": "966751335",
              "name": "key",
              "value": "JRA-987222",
              "integration_id": 186281709,
              "service_name": "jira",
              "created_at": "2019-01-01T00:00:00.000Z"
            }
          ]
        }
      ],
      "key_results": [
        {
          "id": "631791848",
          "name": "KR 1",
          "reference_num": "DEMOENT-G-1-KR-1",
          "url": "https://company.aha.io/key_results/DEMOENT-G-1-KR-1",
          "position": 2,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "progress": null,
          "target_metric": "100%",
          "starting_metric": "5%",
          "current_metric": "20%"
        },
        {
          "id": "1017196896",
          "name": "KR 2",
          "reference_num": "DEMOENT-G-1-KR-2",
          "url": "https://company.aha.io/key_results/DEMOENT-G-1-KR-2",
          "position": 1,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "progress": null,
          "target_metric": null,
          "starting_metric": null,
          "current_metric": null
        }
      ],
      "comments_count": 1,
      "features": [
        {
          "id": "1007868956",
          "name": "Feature 1",
          "reference_num": "PRJ1-1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "product_id": "131414752",
          "url": "https://company.aha.io/features/PRJ1-1",
          "resource": "https://company.aha.io/api/v1/features/PRJ1-1"
        }
      ],
      "releases": [
        {
          "id": "278327321",
          "product_id": "131414752",
          "reference_num": "PRJ1-R-1",
          "name": "Release 1",
          "start_date": "2019-01-01",
          "release_date": "2019-01-01",
          "parking_lot": false,
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "https://company.aha.io/releases/PRJ1-R-1",
          "resource": "https://company.aha.io/api/v1/releases/PRJ1-R-1",
          "integration_fields": [
            {
              "id": "68217473",
              "name": "id",
              "value": "777",
              "integration_id": 204584239,
              "service_name": "jira",
              "created_at": "2019-01-01T00:00:00.000Z"
            }
          ],
          "owner": {
            "id": "16338845",
            "name": "John Smith",
            "email": "no-reply@aha.io",
            "created_at": "2019-01-01T00:00:00.000Z",
            "updated_at": "2019-01-01T00:00:00.000Z"
          },
          "project": {
            "id": "131414752",
            "reference_prefix": "PRJ1",
            "name": "Project 1",
            "product_line": false,
            "created_at": "2019-01-01T00:00:00.000Z",
            "url": "https://company.aha.io/projects/PRJ1",
            "workspace_type": "product_workspace"
          }
        }
      ],
      "custom_fields": []
    },
    {
      "id": "712130641",
      "name": "Goal 3",
      "reference_num": "DEMOENT-G-3",
      "effort": 40,
      "value": 30,
      "color": "#bada55",
      "position": 2,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "product_id": "131414752",
      "progress": null,
      "progress_source": "progress_manual",
      "url": "https://company.aha.io/strategic_imperatives/DEMOENT-G-3",
      "resource": "https://company.aha.io/strategic_imperatives/DEMOENT-G-3",
      "description": {
        "id": "568840458",
        "body": "Description of project1_strategic_imperative3_no_epoch",
        "notable_id": "712130641",
        "notable_type": "StrategicImperative",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "success_metric": {
        "name": "Metric 3",
        "description": {
          "id": "668008103",
          "body": "Description of project1_strategic_imperative3_no_epoch_strategic_imperative_metric",
          "notable_id": "317154208",
          "notable_type": "StrategicImperativeMetric",
          "editor_version": 1,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "attachments": []
        },
        "workflow_status": {
          "id": "396368932",
          "name": "On Track",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f",
          "workflow_status_category": {
            "id": "112353881",
            "name": "In progress"
          }
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "https://company.aha.io/projects/PRJ1",
        "workspace_type": "product_workspace"
      },
      "initiatives": [],
      "key_results": [],
      "comments_count": 0,
      "features": [],
      "releases": [],
      "custom_fields": []
    },
    {
      "id": "926116263",
      "name": "Goal 4",
      "reference_num": "DEMOENT-G-4",
      "effort": 40,
      "value": 30,
      "color": "#bada55",
      "position": 4,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "product_id": "131414752",
      "progress": null,
      "progress_source": "progress_manual",
      "url": "https://company.aha.io/strategic_imperatives/DEMOENT-G-4",
      "resource": "https://company.aha.io/strategic_imperatives/DEMOENT-G-4",
      "description": {
        "id": "308494954",
        "body": "Description of project1_strategic_imperative4_active_epoch",
        "notable_id": "926116263",
        "notable_type": "StrategicImperative",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "success_metric": {
        "name": "Metric 4",
        "description": {
          "id": "330355042",
          "body": "Description of project1_strategic_imperative4_active_epoch_strategic_imperative_metric",
          "notable_id": "68628439",
          "notable_type": "StrategicImperativeMetric",
          "editor_version": 1,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "attachments": []
        },
        "workflow_status": {
          "id": "396368932",
          "name": "On Track",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f",
          "workflow_status_category": {
            "id": "112353881",
            "name": "In progress"
          }
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "https://company.aha.io/projects/PRJ1",
        "workspace_type": "product_workspace"
      },
      "time_frame": {
        "id": 273422810,
        "name": "2017"
      },
      "initiatives": [],
      "key_results": [],
      "comments_count": 0,
      "features": [],
      "releases": [],
      "custom_fields": []
    },
    {
      "id": "988418543",
      "name": "Goal 2",
      "reference_num": "DEMOENT-G-2",
      "effort": 40,
      "value": 30,
      "color": "#bada55",
      "position": 3,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "product_id": "131414752",
      "progress": null,
      "progress_source": "progress_manual",
      "url": "https://company.aha.io/strategic_imperatives/DEMOENT-G-2",
      "resource": "https://company.aha.io/strategic_imperatives/DEMOENT-G-2",
      "description": {
        "id": "1055602421",
        "body": "Description of goal 2",
        "notable_id": "988418543",
        "notable_type": "StrategicImperative",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "success_metric": {
        "name": "Metric 2",
        "description": {
          "id": "394826695",
          "body": "Description of goal 2",
          "notable_id": "440350252",
          "notable_type": "StrategicImperativeMetric",
          "editor_version": 1,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "attachments": []
        },
        "workflow_status": {
          "id": "396368932",
          "name": "On Track",
          "position": 2,
          "complete": false,
          "color": "#ecdd8f",
          "workflow_status_category": {
            "id": "112353881",
            "name": "In progress"
          }
        }
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "https://company.aha.io/projects/PRJ1",
        "workspace_type": "product_workspace"
      },
      "initiatives": [],
      "key_results": [
        {
          "id": "195428809",
          "name": "KR 3",
          "reference_num": "DEMOENT-G-1-KR-3",
          "url": "https://company.aha.io/key_results/DEMOENT-G-1-KR-3",
          "position": 3,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "progress": null,
          "target_metric": null,
          "starting_metric": null,
          "current_metric": null
        }
      ],
      "comments_count": 0,
      "features": [],
      "releases": [],
      "custom_fields": []
    }
  ],
  "pagination": {
    "total_records": 5,
    "total_pages": 1,
    "current_page": 1
  }
}

Changes