Retrieves a list of transaction timeline messages.
Retrieves a list of transaction timeline messages.
limit | integer [ 0 .. 1000 ] Limits the number of collection items to be returned. |
offset | integer [ 0 .. 1000 ] Specifies the starting point within the collection of items to be returned. |
filter | string Filters the collection items. This field requires a special format. Use For more information, see Using filter with collections. |
sort | Array of strings Sorts and orders the collection of items. To sort in descending order, prefix with |
q | string Use this field to perform a partial search of text fields. |
// all parameters are optional except for the `id` const firstCollection = await api.transactions .getAllTimelineMessages({id: 'my-transaction'}); // alternatively you can specify one or more of them const params = {id: 'my-transaction', limit: 20, offset: 100}; const secondCollection = await api.transactions.getAllTimelineMessages(params); // access the collection items, each item is a Member secondCollection.items .forEach(message => console.log(message.fields.eventType));
200
List of transaction timeline messages retrieved.
401
Unauthorized access. Invalid credentials used.
403
Access forbidden.
[ { "id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC", "type": "amount-adjusted", "triggeredBy": "rebilly", "message": "string", "extraData": { "actions": [ { "action": "redemption-cancel", "redemptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21" } ], "tables": [ { "type": "list", "title": "string", "footer": "string" } ], "author": { "userFullName": "string", "userId": "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4" }, "mentions": { "@test@mail.com": "userId-1" }, "links": [ { "resourceType": "kyc-document", "resourceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21", "placeholder": "KYC document", "externalUrl": "http://example.com" } ] }, "occurredTime": "2019-08-24T14:15:22Z", "_links": [ { "href": "string", "rel": "self" } ] } ]