Other documentationsCommunity

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.

get
Authorizations
Path parameters
projectNamestring · min: 1required

The case sensitive project name

Query parameters
limitinteger · min: 1 · max: 100optional

This specifies a limit on the number of objects to return, ranging between 1 and 100. Limit is set to 10 by default

Default: 10
userEmailstring · emailoptional

The administrator email

userIdinteger · min: 1optional

The administrator id

typestring · enumoptional

The type of action performed

Available options:
initiatorstring · enumoptional

The entity that initiated the action

Available options:
resourcestring · enumoptional

The resource affected by the action

Available options:
createdAt.eqstring · date-timeoptional

Value to filter by

createdAt.ltstring · date-timeoptional

Maximum value to filter by (exclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.ltestring · date-timeoptional

Minimum value to filter by (inclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.gtstring · date-timeoptional

Minimum value to filter by (exclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.gtestring · date-timeoptional

Maximum value to filter by (inclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

Responses
curl -L \
  --url 'https://public-api.forestadmin.com/v1/project/{projectName}/admin-logs' \
  --header 'Authorization: Bearer JWT'
{
  "hasMore": false,
  "parameters": {
    "projectName": "Forest"
  },
  "data": [
    {
      "object": "adminLog",
      "id": "rbCb98wCZ1y-_zv4wrXz",
      "type": "update",
      "initiator": "administrator",
      "createdAt": "2024-03-14T15:09:26.535Z",
      "resource": "team",
      "newValue": {
        "name": "Managers UK"
      },
      "user": {
        "object": "user",
        "id": 40,
        "username": "Alice",
        "email": "alice@forestadmin.com"
      },
      "previousValue": {
        "name": "Managers"
      }
    },
    {
      "object": "adminLog",
      "id": "fHCb9IXCZ1y_Pzv4wrXz",
      "type": "add",
      "initiator": "administrator",
      "createdAt": "2024-03-14T15:11:28.148Z",
      "resource": "user-project",
      "newValue": {
        "user": {
          "object": "user",
          "id": 45,
          "username": "John",
          "email": "john@forestadmin.com"
        },
        "role": {
          "object": "role",
          "name": "everything allowed"
        },
        "teams": [
          {
            "object": "team",
            "name": "Managers UK"
          }
        ],
        "permissionLevel": "editor"
      },
      "user": {
        "object": "user",
        "id": 40,
        "username": "Alice",
        "email": "alice@forestadmin.com"
      }
    }
  ]
}

List of admin logs

PreviousActivity logsNextNotes

Last updated