Public API
Other documentationsCommunity
  • Forest Admin API
  • Authentication
  • Endpoints
    • Activity logs
    • Admin logs
    • Notes
  • Rate limit
Powered by GitBook
On this page
  1. Endpoints

Notes

PreviousAdmin logsNextRate limit

Last updated 11 months ago

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

List notes

This endpoint allows to list notes and its messages on a particular project and environment.

Records are returned sorted by id primary key, in descending order (from most recent to least recent).

Pagination can be achieved by filtering on createdAt date.

contact us
get
Authorizations
Path parameters
environmentNamestring · min: 1Required

The case sensitive environment name

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 user email

userIdinteger · min: 1Optional

The user id

teamNamestring · min: 1Optional

The team name

collectionNamestring · min: 1Optional

The collection name (same as in the schema).

recordIdstring · min: 1Optional

The record id

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.

updatedAt.eqstring · date-timeOptional

Value to filter by

updatedAt.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.

updatedAt.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.

updatedAt.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.

updatedAt.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.

archivedAt.eqstring · date-timeOptional

Value to filter by

archivedAt.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.

archivedAt.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.

archivedAt.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.

archivedAt.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
200
List of notes
application/json
429
Too many requests
application/json
4XX
Client error
application/json
5XX
Unexpected error
application/json
get
GET /v1/project/{projectName}/environment/{environmentName}/notes HTTP/1.1
Host: public-api.forestadmin.com
Authorization: Bearer JWT
Accept: */*
{
  "hasMore": false,
  "parameters": {
    "projectName": "Forest",
    "environmentName": "Production",
    "limit": 10
  },
  "data": [
    {
      "object": "note",
      "id": 42,
      "title": "THE TITLE",
      "recordId": "10",
      "createdAt": "2024-02-20T10:35:54.685Z",
      "updatedAt": "2024-03-10T10:36:54.685Z",
      "archivedAt": "2024-05-22T14:01:23.015Z",
      "user": {
        "object": "user",
        "id": 1,
        "username": "alice1",
        "email": "alice@somewhere.com"
      },
      "environment": {
        "object": "environment",
        "name": "aName"
      },
      "team": {
        "object": "team",
        "name": "aName"
      },
      "collection": {
        "object": "collection",
        "name": "client"
      },
      "messages": [
        {
          "object": "note-message",
          "content": "<p>Needs to be verified</p>",
          "createdAt": "2024-02-20T10:35:54.685Z",
          "user": {
            "object": "user",
            "email": "alice@somewhere.com",
            "id": 1,
            "username": "alice"
          }
        },
        {
          "object": "note-message",
          "content": "<p>Ok</p>",
          "createdAt": "2024-02-20T11:15:32.461Z",
          "user": {
            "object": "user",
            "email": "bob@somewhere.com",
            "id": 1,
            "username": "bob"
          }
        }
      ]
    }
  ]
}
  • List notes
  • GET/v1/project/{projectName}/environment/{environmentName}/notes