Initiatives API

List initiatives

GET /api/v1/initiatives

Parameters
Name	Description
`page`	Page number to return.
`per_page`	Number of records to return per page.
`q`	Search term to match against initiative name.
`updated_since`	UTC timestamp (in ISO8601 format). If provided, only initiatives updated after the timestamp will be returned.
`assigned_to_user`	ID or email address of a user. If provided, returns only initiatives assigned to that user.
`only_active`	When true, returns only active initiatives.
`workflow_status`	Workflow status ID or name. If provided, only initiatives with that workflow status will be returned.
`custom_fields`	Hash of custom field key-value pairs. If provided, only initiatives matching all specified custom field values will be returned. Example: {"field_key": "field_value"}

Example request

GET /api/v1/initiatives?page=1&per_page=30

Example CURL command

curl -g "https://company.aha.io/api/v1/initiatives?page=1&per_page=30" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body