Skip to content

actions

Action plans and their steps: your steps across every plan in one call, a step's status, and plans to read, create, edit and archive.

Operations

Your steps across every plan

Request

Steps across all your plans in one page, with the total: filter by status, due date and who owns them. Use this when someone asks what is due, late or blocked, without reading each plan. One page with the counted total, soonest due first and undated last. dueBefore and dueAfter are inclusive; a step with no due date matches neither. assignee=me (the default) is steps assigned to you; any is every step of a plan you can read.

Security
bearerKey
Query
cursorstring, [ 1 .. 500 ] characters
limitinteger, [ 1 .. 100 ]
Default:25
statusArray of strings
Items Enum:"todo""in_progress""blocked""done""cancelled"
dueBeforestring, (date)
dueAfterstring, (date)
assigneestring
Default:"me"
Enum:"me""any"
curl -i -X GET \
  https://docs.hrcledger.com/_mock/docs/openapi/api/v1/actions/steps \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Done.

Bodyapplication/json
okanyrequired
Value:true
dataobjectrequired
Response
{
  "ok": true,
  "data": {
    "items": [ … ],
    "nextCursor": null,
    "total": 1
  }
}