Notes

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

GEThttps://public-api.forestadmin.com/v1/project/{projectName}/environment/{environmentName}/notes

Authorization

bearerAuth

Path parameters

environmentName*string

The case sensitive environment name

projectName*string

The case sensitive project name

Query parameters

Response

2004294XX5XX

List of notes

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 notes

Request

JavaScriptCurlPython

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

Response

2004294XX5XX

{
  "hasMore": false,
  "data": [
    {
      "object": "note",
      "title": "text",
      "recordId": "text",
      "createdAt": "2024-11-21T09:49:47.960Z",
      "collection": {
        "object": "collection",
        "name": "text"
      },
      "messages": [
        {
          "object": "note-message",
          "content": "text",
          "createdAt": "2024-11-21T09:49:47.960Z",
          "user": {
            "object": "user",
            "email": "[e-mail]",
            "username": "text"
          }
        }
      ],
      "updatedAt": "2024-11-21T09:49:47.960Z",
      "user": {
        "object": "user",
        "email": "[e-mail]",
        "username": "text"
      },
      "environment": {
        "object": "environment",
        "name": "text"
      },
      "team": {
        "object": "team",
        "name": "text"
      }
    }
  ],
  "parameters": {
    "environmentName": "text",
    "projectName": "text",
    "userEmail": "[e-mail]",
    "teamName": "text",
    "collectionName": "text",
    "recordId": "text",
    "createdAt.eq": "2024-11-21T09:49:47.960Z",
    "createdAt.lt": "2024-11-21T09:49:47.960Z",
    "createdAt.lte": "2024-11-21T09:49:47.960Z",
    "createdAt.gt": "2024-11-21T09:49:47.960Z",
    "createdAt.gte": "2024-11-21T09:49:47.960Z",
    "updatedAt.eq": "2024-11-21T09:49:47.960Z",
    "updatedAt.lt": "2024-11-21T09:49:47.960Z",
    "updatedAt.lte": "2024-11-21T09:49:47.960Z",
    "updatedAt.gt": "2024-11-21T09:49:47.960Z",
    "updatedAt.gte": "2024-11-21T09:49:47.960Z"
  }
}