/v0/notes/:id

GET

/v0/notes/:id

const url = 'http://localhost:3000/v0/notes/:id';
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/notes/:id

Parameters

Path Parameters

required

Note ID

string

Example

Note ID

Responses

200

application/json

object

required

Note ID

string

content

required

Note content

string

contents_warning_comment

required

Contents warning comment

string

send_to

Send to account ID

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

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

renoted

required

Whether the current user has renoted this note (always false if not logged in)

boolean

Example

{
  "id": "38477395",
  "content": "hello world!",
  "contents_warning_comment": "(if length not 0) This note contains sensitive content",
  "send_to": "38477395",
  "visibility": "PUBLIC",
  "created_at": "2021-01-01T00:00:00Z",
  "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"
    }
  ],
  "renoted": false
}

404

Note not found

application/json

Note not found

object

error

required

Note not found

string

Allowed values: NOTE_NOT_FOUND

Example

{
  "error": "NOTE_NOT_FOUND"
}

500

Internal Server Error

application/json

Internal Error

object

error

required

Internal Error

string

Allowed values: INTERNAL_ERROR

Example

{
  "error": "INTERNAL_ERROR"
}