Skip to main content
GET
/
v1
/
notes
List notes
curl --request GET \
  --url https://api.folk.app/v1/notes \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "nte_91118b73-5a75-480b-b8e3-a33671c35cdc",
        "entity": {
          "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
          "entityType": "person",
          "fullName": "John Doe"
        },
        "visibility": "public",
        "content": "This is a note about John Doe",
        "author": {
          "id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
          "fullName": "John Doe",
          "email": "john.doe@example.com"
        },
        "createdAt": "2021-01-01T00:00:00.000Z",
        "parentNote": {
          "id": "nte_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
          "entity": {
            "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
            "entityType": "person",
            "fullName": "John Doe"
          },
          "content": "This is a parent note about John Doe",
          "visibility": "public",
          "author": {
            "id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
            "fullName": "John Doe",
            "email": "john.doe@example.com"
          },
          "createdAt": "2021-01-01T00:00:00.000Z",
          "deleted": false
        }
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/notes?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication

Query Parameters

​
limit
integer
default:20

The number of items to return.

Required range: 1 <= x <= 100
​
cursor
string

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Maximum length: 128
​
entity.id
string

Filter notes by entity. Only notes linked to the specified entity will be returned.

Required string length: 40

Response

A paginated list of notes in the workspace.

​
data
object
required
Example:
{
  "items": [
    {
      "id": "nte_91118b73-5a75-480b-b8e3-a33671c35cdc",
      "entity": {
        "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
        "entityType": "person",
        "fullName": "John Doe"
      },
      "visibility": "public",
      "content": "This is a note about John Doe",
      "author": {
        "id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
        "fullName": "John Doe",
        "email": "john.doe@example.com"
      },
      "createdAt": "2021-01-01T00:00:00.000Z",
      "parentNote": {
        "id": "nte_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
        "entity": {
          "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
          "entityType": "person",
          "fullName": "John Doe"
        },
        "content": "This is a parent note about John Doe",
        "visibility": "public",
        "author": {
          "id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
          "fullName": "John Doe",
          "email": "john.doe@example.com"
        },
        "createdAt": "2021-01-01T00:00:00.000Z",
        "deleted": false
      }
    }
  ],
  "pagination": {
    "nextLink": "https://api.folk.app/v1/notes?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
  }
}
​
deprecations
string[]
Example:
["This field is deprecated"]