List events
GET {{baseInfraUrl}}/{{version}}/event
Get a list of non-deleted events in chunks of at most 100. If you need smaller chunks, use the limit parameter.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
cursor | null | String used to get the next batch of results. | |
limit | null | Number of results per cursor. Max = 100. | |
fields | null | List of strings to filter response JSON keys. | |
after | null | Filter entities created after this date. | |
before | null | Filter entities created before this date. | |
isDelivered | null | If false, only gets events that haven't been delivered. If true, only gets events that have already been delivered. |
RESPONSES
status: OK
{"cursor":"Ck0KFAoHY3JlYXRlZBIJCOzOjcus5_cCEjFqFGl-YXBpLW1zLXdlYmhvb2stZGV2chkLEgxOb3RpZmljYXRpb24YgICAhP6w2woMGAAgAQ==","events":[{"created":"2022-05-17T20:14:24.267083+00:00","id":"6414584130830336","isDelivered":true,"log":{"errors":[],"id":"6483512089640960","note":{"amount":193461,"created":"2022-05-17T20:14:23.054318+00:00","documentId":"6647908271128576","expiration":"2022-08-05T07:00:00+00:00","externalId":"my_unique_id","id":"6425285620662272","interest":20.55,"invoices":[{"amount":234413,"descriptions":[],"discounts":[],"due":"2023-06-17T02:59:59.999999+00:00","expiration":5097600,"fine":3,"id":"","interest":1,"name":"Jamie Lannister","tags":[],"taxId":"012.345.678-90"}],"name":"Jamie Lannister","nominalAmount":200000,"payment":{"accountNumber":"5005482","accountType":"checking","amount":193461,"bankCode":"60701190","branchCode":"7248","id":"","name":"Jamie Lannister","scheduled":"2022-05-17T20:14:22.858881+00:00","status":"","tags":[],"taxId":"594.739.480-42"},"paymentType":"transfer","rebateAmount":0,"scheduled":"2022-06-07T07:00:00+00:00","signers":[{"contact":"jamie.lannister@gmail.com","method":"link","name":"Jamie Lannister"}],"status":"created","tags":[],"taxAmount":6539,"taxId":"012.345.678-90","templateId":"5707012469948416","transactionIds":[],"updated":"2022-05-17T20:14:23.565643+00:00","workspaceId":"6275127679385600"},"type":"registered","updated":"2022-05-17T20:14:23.565648+00:00"},"subscription":"credit-note","workspaceId":"6275127679385600"},{"created":"2022-05-17T20:14:23.385452+00:00","id":"6031404865421312","isDelivered":true,"log":{"errors":[],"id":"5017910737108992","note":{"amount":193461,"created":"2022-05-17T20:14:23.054318+00:00","documentId":"","expiration":"2022-08-05T07:00:00+00:00","externalId":"my_unique_id","id":"6425285620662272","interest":20.55,"invoices":[{"amount":234413,"descriptions":[],"discounts":[],"due":"2023-06-17T02:59:59.999999+00:00","expiration":5097600,"fine":3,"id":"","interest":1,"name":"Jamie Lannister","tags":[],"taxId":"012.345.678-90"}],"name":"Jamie Lannister","nominalAmount":200000,"payment":{"accountNumber":"5005482","accountType":"checking","amount":193461,"bankCode":"60701190","branchCode":"7248","id":"","name":"Jamie Lannister","scheduled":"2022-05-17T20:14:22.858881+00:00","status":"","tags":[],"taxId":"594.739.480-42"},"paymentType":"transfer","rebateAmount":0,"scheduled":"2022-06-07T07:00:00+00:00","signers":[{"contact":"jamie.lannister@gmail.com","method":"link","name":"Jamie Lannister"}],"status":"created","tags":[],"taxAmount":6539,"taxId":"012.345.678-90","templateId":"5707012469948416","transactionIds":[],"updated":"2022-05-17T20:14:23.073297+00:00","workspaceId":"6275127679385600"},"type":"created","updated":"2022-05-17T20:14:23.073303+00:00"},"subscription":"credit-note","workspaceId":"6275127679385600"}]}