Skip to navigation

List Manual Journals

View as Markdown

Returns manual journals newest first, paginated by cursor. Request the next page by passing the keyset and last_id from the previous response; stop when last_id is null.

Requires the can_view_journal_entry permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Query parameters

statusenumOptional
Optional. Filter by journal status.
Allowed values:
searchstringOptional

Optional. Case-insensitive match on transaction reference or description.

sizeintegerOptional1-50Defaults to 20
Optional. Page size. Defaults to 20, capped at 50.
last_idstringOptionalformat: "uuid"

Optional. Cursor from the previous page’s last_id. Send together with keyset.

keysetstringOptional

Optional. Cursor from the previous page’s keyset. Send together with last_id.

Response

OK
statusboolean
messagestring
datalist of objects
keysetstring or nullOptional

Send back as keyset, with last_id, to get the next page. null when there are no more records.

last_idstring or nullOptionalformat: "uuid"

Send back as last_id, with keyset, to get the next page. null when there are no more records.

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error