List actions
list_actionsReturns what Paidnice has scheduled, sent, skipped or failed (reminders, late fees, statements, SMS, escalations and so on), newest first, up to 100 per page. Each action has its status, run dates, any notes or error, and the policies that created it. Filter by contact, invoice, status or type. Read only.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"organisationId": "<organisationId>"
},
"name": "list_actions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Only actions of this type, for example reminder, late_fee or send_statement | |
| limit | No | Maximum number of records to return | |
| cursor | No | Opaque cursor from a previous response's nextCursor. Omit to start from the most recent record. | |
| status | No | pending: waiting for its run date. complete: done. failed: errored, see errorMessage. suspended and approval_pending: waiting for a user. skipped: skipped by a user. reverted: a late fee that was later reversed. | |
| contactId | No | Only actions for this contact | |
| invoiceId | No | Only actions for this invoice, including statements and statement late fees that included it | |
| organisationId | Yes | Id of the organisation to act on, from list_organisations |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| nextCursor | No | Pass as the cursor query parameter to fetch the next page. Absent on the last page. |