List all states

GET/api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/

Returns a list of all states in a project. States are returned in sequence order within their state groups.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

project_id:requiredstring

The unique identifier of the project.

List all states

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/" \
  -H "X-API-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

const response = await fetch('https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your-api-key',
  },
});
const data = await response.json();

Response200

{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}