Skip to main content
GET
/
api
/
v1
/
proposals
List proposals
curl --request GET \
  --url http://localhost:3000/api/v1/proposals \
  --cookie nut-session=
{
  "success": true,
  "data": {
    "proposals": [
      {
        "id": "<string>",
        "title": "<string>",
        "status": "draft",
        "description": "<string>",
        "priority": "low",
        "tags": [
          "<string>"
        ],
        "author": {
          "type": "user",
          "id": "<string>",
          "name": "<string>"
        },
        "changes": [
          {
            "path": "<string>",
            "type": "create",
            "content": "<string>",
            "oldPath": "<string>"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Query Parameters

status
enum<string>

Filter by proposal status Change proposal status

Available options:
draft,
proposed,
in_progress,
review,
approved,
rejected,
implemented,
archived
author
string

Filter by author

priority
enum<string>

Filter by priority level

Available options:
low,
medium,
high,
critical
tags
string

Filter by tags (comma-separated)

Response

List of proposals

success
boolean
required
data
object