Florality

GET

/api/v1/entries

entries: read1,000 requests/minute/key · all plans

Active API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.

Parameters

Query parameters

Name	Type	Required	Description
`limit`	`integer`	Optional	Filter or option: limit. Default: 50. Minimum: 1. Maximum: 100.
`memberId`	`string (uuid)`	Optional	Filter or option: member id.

Behaviour and pagination

Returns an array, not a cursor envelope. This route accepts limit and memberId only; it does not expose an offset or cursor. Note content in list responses is a preview, capped at 1,024 characters. Use the individual entry route for the full content.

Response schema

200

Successful response.

Name	Type	Required	Description
`_id`	`string`	Required	Unique identifier.
`title`	`null \| string`	Optional	Display title.
`content`	`string`	Required	Text content. Preview text for list surfaces (`entries.list`). Full body is returned by `entries.get`.
`createdAt`	`number`	Required	Creation time.
`updatedAt`	`number`	Required	Most recent update time.
`pinnedAt`	`null \| number`	Optional	Pinned At.
`favoritedAt`	`null \| number`	Optional	Favorited At.
`createdByMemberId`	`null \| string`	Optional	Created By Member Id. Member credited as the note author. Null means the account user.
`member`	`null \| object`	Required	Member.
`member.id`	`string`	Required	Unique identifier.
`member.name`	`string`	Required	Name of the resource.
`member.displayName`	`string`	Optional	Display name.
`member.archived`	`boolean`	Required	Archived.
`member.avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`member.profileStyle`	`null \| object`	Optional	Profile presentation settings.
`member.profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`member.profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`member.profileStyle.memberName`	`object`	Optional	Member Name.
`member.profileStyle.bannerImage`	`object`	Optional	Banner Image.
`member.profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`member.profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`member.profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`member.profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`member.profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`member.profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`member.profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`member.profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`member.profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`member.profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`members`	`array<object>`	Required	Members.
`members[].id`	`string`	Required	Unique identifier.
`members[].name`	`string`	Required	Name of the resource.
`members[].displayName`	`string`	Optional	Display name.
`members[].archived`	`boolean`	Required	Archived.
`members[].avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`members[].profileStyle`	`null \| object`	Optional	Profile presentation settings.
`members[].profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`members[].profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`members[].profileStyle.memberName`	`object`	Optional	Member Name.
`members[].profileStyle.bannerImage`	`object`	Optional	Banner Image.
`members[].profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`members[].profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`members[].profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`members[].profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`members[].profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`members[].profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`members[].profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`members[].profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`members[].profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`members[].profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`linkedMemberIds`	`array<string>`	Optional	Linked Member Ids. Entry-linked member ids (for permission checks). Set by list services that load entries.
`noteFolderId`	`null \| string`	Optional	Note Folder Id.
`icon`	`null \| string`	Optional	Icon.
`iconColorPreset`	`null \| string`	Optional	Icon Color Preset.
`tags`	`array<object>`	Optional	Tags.
`tags[].id`	`string`	Required	Unique identifier.
`tags[].name`	`string`	Required	Name of the resource.
`tags[].color`	`null \| string`	Optional	Color.
`tags[].icon`	`null \| string`	Optional	Icon.

Errors

400 · JSON error: Request failed (BAD_REQUEST).
401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires entries: read; ownership or feature restrictions may also deny access.
429 · JSON error: API rate limit exceeded (1000 requests per minute). Retry shortly.

Request example

Set FLORALITY_KEY in your environment. These examples use demo identifiers.

Shell

curl --request GET 'https://floralitys.com/api/v1/entries' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON

[
  {
    "_id": "11111111-1111-4111-8111-111111111111",
    "title": null,
    "content": "A note from our demo system.",
    "createdAt": 1767225600000,
    "updatedAt": 1767225600000,
    "pinnedAt": null,
    "favoritedAt": null,
    "createdByMemberId": null,
    "member": null,
    "members": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "River",
        "displayName": "River",
        "archived": false,
        "avatarUrl": null,
        "profileStyle": null
      }
    ],
    "linkedMemberIds": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "noteFolderId": null,
    "icon": null,
    "iconColorPreset": null,
    "tags": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "River",
        "color": null,
        "icon": null
      }
    ]
  }
]

Example values are illustrative demo data.

Name

Type

Required

Description

limit

integer

Optional

Filter or option: limit. Default: 50. Minimum: 1. Maximum: 100.

memberId

string (uuid)

Optional

Filter or option: member id.

Response schema

200

Successful response.

Name	Type	Required	Description
`_id`	`string`	Required	Unique identifier.
`title`	`null \| string`	Optional	Display title.
`content`	`string`	Required	Text content. Preview text for list surfaces (`entries.list`). Full body is returned by `entries.get`.
`createdAt`	`number`	Required	Creation time.
`updatedAt`	`number`	Required	Most recent update time.
`pinnedAt`	`null \| number`	Optional	Pinned At.
`favoritedAt`	`null \| number`	Optional	Favorited At.
`createdByMemberId`	`null \| string`	Optional	Created By Member Id. Member credited as the note author. Null means the account user.
`member`	`null \| object`	Required	Member.
`member.id`	`string`	Required	Unique identifier.
`member.name`	`string`	Required	Name of the resource.
`member.displayName`	`string`	Optional	Display name.
`member.archived`	`boolean`	Required	Archived.
`member.avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`member.profileStyle`	`null \| object`	Optional	Profile presentation settings.
`member.profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`member.profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`member.profileStyle.memberName`	`object`	Optional	Member Name.
`member.profileStyle.bannerImage`	`object`	Optional	Banner Image.
`member.profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`member.profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`member.profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`member.profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`member.profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`member.profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`member.profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`member.profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`member.profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`member.profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`members`	`array<object>`	Required	Members.
`members[].id`	`string`	Required	Unique identifier.
`members[].name`	`string`	Required	Name of the resource.
`members[].displayName`	`string`	Optional	Display name.
`members[].archived`	`boolean`	Required	Archived.
`members[].avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`members[].profileStyle`	`null \| object`	Optional	Profile presentation settings.
`members[].profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`members[].profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`members[].profileStyle.memberName`	`object`	Optional	Member Name.
`members[].profileStyle.bannerImage`	`object`	Optional	Banner Image.
`members[].profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`members[].profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`members[].profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`members[].profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`members[].profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`members[].profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`members[].profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`members[].profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`members[].profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`members[].profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`linkedMemberIds`	`array<string>`	Optional	Linked Member Ids. Entry-linked member ids (for permission checks). Set by list services that load entries.
`noteFolderId`	`null \| string`	Optional	Note Folder Id.
`icon`	`null \| string`	Optional	Icon.
`iconColorPreset`	`null \| string`	Optional	Icon Color Preset.
`tags`	`array<object>`	Optional	Tags.
`tags[].id`	`string`	Required	Unique identifier.
`tags[].name`	`string`	Required	Name of the resource.
`tags[].color`	`null \| string`	Optional	Color.
`tags[].icon`	`null \| string`	Optional	Icon.

Errors

400 · JSON error

Request failed (BAD_REQUEST).

401 · JSON error

Missing or invalid API key. Use Authorization: Bearer <token>.

403 · JSON error

Requires entries: read; ownership or feature restrictions may also deny access.

429 · JSON error

API rate limit exceeded (1000 requests per minute). Retry shortly.

Responses

Successful response.

JSON

[
  {
    "_id": "11111111-1111-4111-8111-111111111111",
    "title": null,
    "content": "A note from our demo system.",
    "createdAt": 1767225600000,
    "updatedAt": 1767225600000,
    "pinnedAt": null,
    "favoritedAt": null,
    "createdByMemberId": null,
    "member": null,
    "members": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "River",
        "displayName": "River",
        "archived": false,
        "avatarUrl": null,
        "profileStyle": null
      }
    ],
    "linkedMemberIds": [
      "11111111-1111-4111-8111-111111111111"
    ],
    "noteFolderId": null,
    "icon": null,
    "iconColorPreset": null,
    "tags": [
      {
        "id": "11111111-1111-4111-8111-111111111111",
        "name": "River",
        "color": null,
        "icon": null
      }
    ]
  }
]

Example values are illustrative demo data.

List entries

Parameters

Query parameters

Behaviour and pagination

Response schema

200

Errors

Request example

Responses

List entries

Parameters

Query parameters

Behaviour and pagination

Response schema

200

Errors

Request example

Responses