/v0/lists/:id/notes

GET

/v0/lists/:id/notes

const url = 'http://localhost:3000/v0/lists/:id/notes';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/v0/lists/:id/notes

Parameters

Path Parameters

required

string

Query Parameters

has_attachment

If true, only return notes with attachment

boolean

If true, only return notes with attachment

no_nsfw

If true, only return notes without sensitive content

boolean

If true, only return notes without sensitive content

before_id

Return notes before this note ID. specified note ID is not included. NOTE: after_id and before_id are exclusive.

string

Return notes before this note ID. specified note ID is not included. NOTE: after_id and before_id are exclusive.

after_id

Return notes after this note ID. Specified note is not included. NOTE: after_id and before_id are exclusive.

string

Return notes after this note ID. Specified note is not included. NOTE: after_id and before_id are exclusive.

Responses

200

application/json

Array<object>

object

required

Note ID

string

content

required

Note content

string

contents_warning_comment

required

Contents warning comment

string

visibility

required

Note visibility (PUBLIC/HOME/FOLLOWERS/DIRECT)

string

created_at

required

Note created date

string format: date-time

author

required

object

required

string

name

required

string

display_name

required

string

bio

required

string

avatar

required

string

header

required

string

followed_count

required

number

following_count

required

number

original_note_id

Original note ID (if this note is a renote)

string

reactions

required

Reactions

Array<object>

object

emoji

required

Any of:

string
string

string

reacted_by

required

Reacted account ID

string

attachment_files

required

Note Attachment Media

Array<object>

<= 16 items

object

required

Attachment Medium id

string

name

required

Attachment filename

string

author_id

required

Attachment author account id

string

hash

required

Attachment medium blurhash

string

mime

required

Attachment medium mime type

string

nsfw

required

If true, attachment is nsfw

boolean

url

required

Attachment medium url

string format: uri

thumbnail

required

Attachment thumbnail url

string

Example

[
  {
    "id": "38477395",
    "content": "hello world!",
    "contents_warning_comment": "(if length not 0) This note contains sensitive content",
    "visibility": "PUBLIC",
    "created_at": "2021-01-01T00:00:00Z",
    "original_note_id": "38477395",
    "reactions": [
      {
        "emoji": "🎉",
        "reacted_by": "38477395"
      }
    ],
    "attachment_files": [
      {
        "id": "39783475",
        "name": "image.jpg",
        "author_id": "309823457",
        "hash": "e9f*5oin{dn",
        "mime": "image/jpeg",
        "nsfw": false,
        "url": "https://images.example.com/image.webp",
        "thumbnail": "https://images.example.com/image_thumbnail.webp"
      }
    ]
  }
]

404

List not found

application/json

object

error

required

Any of:

string
string

No more notes exist

string

Allowed values: NOTHING_LEFT

Example

{
  "error": "LIST_NOT_FOUND"
}

500

Internal error

application/json

Internal server error

object

error

required

Internal server error

string

Allowed values: INTERNAL_ERROR

Example

{
  "error": "INTERNAL_ERROR"
}