Skip to main content
GET
/
v1
/
workspaces
/
{workspaceId}
/
events
Query retained records
curl --request GET \
  --url https://lodger.dev/v1/workspaces/{workspaceId}/events \
  --header 'Authorization: Bearer <token>'
{
  "events": [
    {
      "workspaceId": "<string>",
      "projectId": "<string>",
      "action": "<string>",
      "actor": {
        "id": "<string>",
        "email": "<string>"
      },
      "target": {
        "id": "<string>",
        "type": "<string>",
        "name": "<string>"
      },
      "occurredAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "userVisible": true,
      "id": "<string>",
      "sequence": 123,
      "hash": "<string>",
      "previousHash": "<string>",
      "receipt": "<string>",
      "lane": "<string>",
      "storageTier": "<string>",
      "integrity": "<string>"
    }
  ],
  "returned": 123,
  "total": 123,
  "nextCursor": 123,
  "verified": true
}

Authorizations

​
Authorization
string
header
default:lodger_sk_your_key
required

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

Path Parameters

​
workspaceId
string
required
Example:

"org_01JZ2M9E7G6D8R5K3D"

Query Parameters

​
projectId
string
default:all
​
query
string
​
lane
enum<string>
Available options:
all,
security,
data,
policy,
operations
​
storage
enum<string>
Available options:
all,
hot,
archive
​
includeArchive
boolean
default:false
​
userVisible
boolean
​
from
string<date-time>
​
to
string<date-time>
​
cursor
integer
Required range: x >= 0
​
limit
integer
default:50
Required range: 1 <= x <= 100

Response

A page of ledger entries.

​
events
object[]
required
​
returned
integer
required
​
total
integer
required
​
nextCursor
integer
required
​
verified
boolean
required