List key results
GET /api/v3/key_results
Key results are only available for accounts on the Enterprise+ plans.
The request and response builder is not available for this endpoint. See the OpenAPI specification for complete parameters and schemas.
Fields
Choose fields to return, filter, or sort. Expand a field for examples and associated fields. Collections can only be returned on the top-level resource, not inside an associated resource.
| Field | Type | Returned by default | Sortable | Supported filters |
|---|---|---|---|---|
Unique record ID. | integer | Yes | Yes | eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty |
Return this field: Filter example: Sort: | ||||
URL to view the record in Aha! | string | Yes | No | None |
Return this field: | ||||
API URL for the record. | string | Yes | No | None |
Return this field: | ||||
Reference number of the record. | string | Yes | Yes | eqnot_eqcontainsstarts_withinnot_inemptynot_empty |
Return this field: Filter example: Sort: | ||||
Name of the record. | string | Yes | Yes | eqnot_eqcontainsstarts_withinnot_inemptynot_empty |
Return this field: Filter example: Sort: | ||||
Position of the record relative to its siblings. | integer | No | Yes | eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty |
Return this field: Filter example: Sort: | ||||
Progress completed for the record. | number | No | Yes | eqnot_eqgtgteltlteinnot_inbetweenemptynot_empty |
Return this field: Filter example: Sort: | ||||
Target value of the key result's metric. | string | No | Yes | eqnot_eqcontainsstarts_withinnot_inemptynot_empty |
Return this field: Filter example: Sort: | ||||
Starting value of the key result's metric. | string | No | Yes | eqnot_eqcontainsstarts_withinnot_inemptynot_empty |
Return this field: Filter example: Sort: | ||||
Current value of the key result's metric. | string | No | Yes | eqnot_eqcontainsstarts_withinnot_inemptynot_empty |
Return this field: Filter example: Sort: | ||||
Date and time when the record was created. | date-time | No | Yes | eqgtgteltltebetweenemptynot_empty |
Return this field: Filter example: Sort: | ||||
Date and time when the record was last updated. | date-time | No | Yes | eqgtgteltltebetweenemptynot_empty |
Return this field: Filter example: Sort: | ||||
Status assigned to the record. | Status | No | No | emptynot_empty |
Return this field: Filter example: Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. Select subfields with | ||||
User assigned to the record. | AssignedToUser | No | No | emptynot_empty |
Return this field: Filter example: Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. Select subfields with | ||||
HTML description of the record. | Note | No | No | emptynot_empty |
Return this field: Filter example: Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. Select subfields with | ||||
Goal that contains the key result. | Goal | No | No | emptynot_empty |
Return this field: Filter example: Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. Select subfields with | ||||
Internal comments on the record. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=comments[default]). Capped at 25 records. Only available on the top-level resource. | Collection | No | No | emptynot_empty |
Return this field: Filter example: Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. Select subfields with | ||||
Custom field values. Property names are custom field definition keys, and each value is one of the supported formats below, depending on the field type. Omitted unless requested with the fields parameter or submitted in the request. Fields with no stored value are omitted. | object | No | No | By custom field type |
Return this field: Custom field keys depend on your account. Request Filter with
Other custom field types cannot be filtered. Custom fields cannot be sorted. | ||||
Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource. | Collection | No | No | emptynot_empty |
Return this field: Filter example: Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. Select subfields with | ||||
Status intervals for the record. Use started_at to identify when it entered a status. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=workflow_status_times[default]). Capped at 25 records. Only available on the top-level resource. | Collection | No | No | None |
Return this field: Association filters apply to this field itself. Expand its subfields below to see their individual capabilities. Select subfields with | ||||
Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.
Query syntax
Return selected fields with a comma-separated fields parameter, or add a field to the defaults with fields=default,{field}. Expand an association above for its supported subfields and selection examples.
Filter with filter.{operator}[{field}]=value. Multiple filters combine with AND. Use comma-separated values for in and not_in, two inclusive bounds for between, and true for empty and not_empty.
Sort with sort.asc={field} or sort.desc={field}. Explicit sorting limits results to 1,000 records. Omit sorting to retrieve all results in descending ID order.
Set the page size with per_page. Follow pagination.next_url while pagination.has_more is true.
Filter operators
eq equals; not_eq does not equal; contains contains text; starts_with starts with text (both case-insensitive).
gt greater than; gte greater than or equal; lt less than; lte less than or equal.
in matches any listed value; not_in excludes listed values; between matches an inclusive range; empty and not_empty check for an absent or present value.
See field selection, filtering, and pagination and sorting limits for details.