Admin logs

This API is not available for self-service at the moment, and you will need to contact us if you are interested in using it.

List admin logs

This endpoint allows to list admin logs on a particular project.

Records are returned sorted by createdAt date, in descending order (from most recent to least recent).

Pagination can be achieved by filtering on createdAt date.

GEThttps://public-api.forestadmin.com/v1/project/{projectName}/admin-logs

Authorization

bearerAuth

Path parameters

projectName*string

The case sensitive project name

Query parameters

Response

2004294XX5XX

List of admin logs

Body

application/json

hasMore*boolean

Whether or not there are more elements available after this set. If false, this set comprises the end of the list.

data*array of object

parameters*object

The parameters used to fetch the admin logs

Request

JavaScriptCurlPython

const response = await fetch('https://public-api.forestadmin.com/v1/project/{projectName}/admin-logs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

2004294XX5XX

{
  "hasMore": false,
  "data": [
    {
      "object": "adminLog",
      "id": "text",
      "type": "add",
      "resource": "user-project",
      "initiator": "administrator",
      "createdAt": "2024-10-18T07:24:33.105Z",
      "user": {
        "object": "user",
        "email": "[e-mail]",
        "username": "text"
      },
      "newValue": {
        "user": {
          "object": "user",
          "email": "[e-mail]",
          "username": "text"
        },
        "permissionLevel": "admin",
        "tags": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "role": {
          "object": "role",
          "name": "text"
        },
        "teams": [
          {
            "object": "team",
            "name": "text"
          }
        ]
      },
      "previousValue": {
        "user": {
          "object": "user",
          "email": "[e-mail]",
          "username": "text"
        },
        "permissionLevel": "admin",
        "tags": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "role": {
          "object": "role",
          "name": "text"
        },
        "teams": [
          {
            "object": "team",
            "name": "text"
          }
        ]
      }
    }
  ],
  "parameters": {
    "projectName": "text",
    "userEmail": "[e-mail]",
    "type": "add",
    "initiator": "administrator",
    "resource": "user-project",
    "createdAt.eq": "2024-10-18T07:24:33.105Z",
    "createdAt.lt": "2024-10-18T07:24:33.105Z",
    "createdAt.lte": "2024-10-18T07:24:33.105Z",
    "createdAt.gt": "2024-10-18T07:24:33.105Z",
    "createdAt.gte": "2024-10-18T07:24:33.105Z"
  }
}