Skip to main content
The /v1/initiatives endpoint returns a paginated list of your account’s initiatives — the action items teams derive from survey results. Each entry contains the full data of an initiative, so you can sync action plans and their progress into your warehouse. An initiative is identified by its uuid. The surveys, questions, and employees it references are exposed by the same integer IDs returned by the /v1/surveys, /v1/questions, and /v1/employees endpoints, so you can cross-reference them. Initiatives are returned ordered by created_at descending.

Endpoint

Query Parameters

integer
Maximum number of initiatives to return per page. Accepts values from 0 to 1000. Defaults to 100.
integer
Number of initiatives to skip before returning results. Defaults to 0.
string
Return only initiatives with this status. One of draft, defined, in_progress, or completed. Omit to return initiatives of any status.

Example Request

Example Response

Response Fields

integer
Total number of initiatives matching the query. Use this value to calculate how many pages to fetch when paginating.
array
List of initiative objects.
Use total_count to calculate how many pages to fetch. See Pagination for a complete walkthrough.