List all initiatives

GET/api/v1/workspaces/{slug}/initiatives/

List all initiatives in the workspace

Path Parameters

slug:requiredstring

Workspace slug

Query Parameters

cursor:optionalstring

Pagination cursor for getting next set of results

per_page:optionalinteger

Number of results per page (default: 20, max: 100)

Scopes

initiatives:read

List all initiatives

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/?cursor=20:1:0&per_page=20" \
  -H "X-API-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/?cursor=20:1:0&per_page=20",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/?cursor=20:1:0&per_page=20",
  {
    method: "GET",
    headers: {
      "X-API-Key": "your-api-key",
    },
  }
);
const data = await response.json();

Response200

[
  {
    "grouped_by": "state",
    "sub_grouped_by": "priority",
    "total_count": 150,
    "next_cursor": "20:1:0",
    "prev_cursor": "20:0:0",
    "next_page_results": true,
    "prev_page_results": false,
    "count": 20,
    "total_pages": 8,
    "total_results": 150,
    "extra_stats": null,
    "results": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name",
        "description": "Example description",
        "created_at": "2024-01-01T00:00:00Z"
      }
    ]
  }
]