Get Requirements

GET/api/requirements

Retrieves a list of requirements. You can filter by various fields including status, creation date, and more.

Query Parameters

Parameter	Type	Required	Description
`site_id`	`string`	No	Filter requirements by a specific site ID.
`user_id`	`string`	No	Filter requirements by a specific user ID.
`status`	`string`	No	Filter requirements by a specific status (e.g., `in-progress`, `backlog`).
`completion_status`	`string`	No	Filter requirements by a specific completion status (e.g., `pending`, `completed`).
`excluded_statuses`	`string`	No	Comma-separated list of statuses to exclude (e.g., `validated`).
`excluded_completion_statuses`	`string`	No	Comma-separated list of completion statuses to exclude (e.g., `completed`).
`created_at_from`	`string`	No	Filter requirements created on or after this date (ISO 8601 format).
`created_at_to`	`string`	No	Filter requirements created on or before this date (ISO 8601 format).
`updated_at_from`	`string`	No	Filter requirements updated on or after this date (ISO 8601 format).
`updated_at_to`	`string`	No	Filter requirements updated on or before this date (ISO 8601 format).
`limit`	`number`	No	The maximum number of requirements to return. Default: `50`, Max: `100`.
`offset`	`number`	No	The number of requirements to skip before returning results. Default: `0`.

Example Request


curl -X GET "https://api.makinari.com/api/requirements?site_id=123&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Returns a list of requirements along with pagination information.


{
  "success": true,
  "data": {
    "requirements": [
      {
        "id": "req_123",
        "title": "Example Requirement",
        "status": "pending",
        "cron": "every monday",
        "cycle": "Sprint 4"
      }
    ],
    "pagination": {
      "total": 150,
      "count": 10,
      "has_more": true,
      "limit": 10,
      "offset": 0
    }
  }
}