Florality

GET

/api/v1/friends/{friendUserId}/members/page

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

Friend-visible member data

For friend callers, member visibility is filtered by privacy-bucket access. Profile-section restrictions omit displayName, pronouns and about; aboutTags becomes an empty array. Hidden avatar data omits avatar and sets avatarUrl to null. Hidden profile styling sets profileStyle and backgroundUrl to null and omits background. Avatar access also requires an accepted, unblocked friendship and overlapping member and section buckets. The owner is not redacted by this friend-view filter.

Parameters

Path parameters

Name	Type	Required	Description
`friendUserId`	`string (uuid)`	Required	Identifier of the friend user.

Query parameters

Name	Type	Required	Description
`limit`	`integer`	Required	Filter or option: limit. Minimum: 1. Maximum: 100.
`cursor`	`integer`	Optional	Filter or option: cursor. Minimum: 0.
`query`	`string`	Optional	Filter or option: query. Maximum length: 200.

Behaviour and pagination

Omit cursor for the first page. Pass the nextCursor value from the response into the next request; if nextCursor is an object, use its index property. A null nextCursor indicates the end.

Response schema

200

Successful response.

Name	Type	Required	Description
`items`	`array<object>`	Required	Items returned by this request.
`items[]._id`	`string`	Required	Unique identifier.
`items[].userId`	`string`	Required	Owning account identifier.
`items[].directoryId`	`string`	Required	Containing folder identifier.
`items[].sideSystemId`	`string`	Optional	Side System Id.
`items[].subSystemId`	`string`	Optional	Sub System Id.
`items[].name`	`string`	Required	Name of the resource.
`items[].displayName`	`string`	Optional	Display name.
`items[].pronouns`	`string`	Optional	Member pronouns.
`items[].avatar`	`string`	Optional	Avatar storage reference.
`items[].about`	`string`	Optional	Member profile text.
`items[].aboutTags`	`array<string>`	Required	Tags attached to the profile text. Labels shown on the member About card (same semantics as custom-field tags).
`items[].background`	`string`	Optional	Background storage reference.
`items[].archivedAt`	`number`	Optional	Archiving time; null when active.
`items[].createdAt`	`number`	Optional	Creation time.
`items[].updatedAt`	`number`	Optional	Most recent update time.
`items[].deletedAt`	`number`	Optional	Deletion time; null when active.
`items[].purgeAt`	`number`	Optional	Purge At.
`items[].originalDirectoryId`	`string`	Optional	Original Directory Id.
`items[].profileStyle`	`null \| object`	Required	Profile presentation settings.
`items[].profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`items[].profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`items[].profileStyle.memberName`	`object`	Optional	Member Name.
`items[].profileStyle.bannerImage`	`object`	Optional	Banner Image.
`items[].profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`items[].profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`items[].profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`items[].profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`items[].profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`items[].profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`items[].profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`items[].profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`items[].profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`items[].profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`items[].avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`items[].backgroundUrl`	`null \| string`	Required	Resolved background URL, or null when unavailable.
`items[].linkedSubSystems`	`array<object>`	Optional	Linked Sub Systems. Sub systems that list this member as their linked profile (`sub_systems.linked_member_id`). Distinct from `subSystemId` (member row lives inside a sub system).
`items[].linkedSubSystems[]._id`	`string`	Required	Unique identifier.
`items[].linkedSubSystems[].name`	`string`	Required	Name of the resource.
`items[].linkedSubSystems[].sideSystemId`	`string`	Required	Side System Id.
`nextCursor`	`null \| object`	Required	Cursor for the next page; null when there are no further results.
`nextCursor.index`	`number`	Required	Index.
`total`	`number`	Required	Total.
`memberProfileReadByMemberId`	`object`	Required	Member Profile Read By Member Id.

Errors

400 · JSON error: Missing friend user id.
401 · JSON error: Missing or invalid API key. Use Authorization: Bearer <token>.
403 · JSON error: Requires friends: read; ownership or feature restrictions may also deny access.
404 · JSON error: Request failed (NOT_FOUND).
409 · JSON error: Request failed (CONFLICT).
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/friends/11111111-1111-4111-8111-111111111111/members/page?limit=20' \
  --header "Authorization: Bearer $FLORALITY_KEY"

Responses

Successful response.

JSON

{
  "items": [
    {
      "_id": "11111111-1111-4111-8111-111111111111",
      "userId": "11111111-1111-4111-8111-111111111111",
      "directoryId": "11111111-1111-4111-8111-111111111111",
      "sideSystemId": "11111111-1111-4111-8111-111111111111",
      "subSystemId": "11111111-1111-4111-8111-111111111111",
      "name": "River",
      "displayName": "River",
      "pronouns": "they/them",
      "avatar": "demo",
      "about": "A note from our demo system.",
      "aboutTags": [
        "A note from our demo system."
      ],
      "background": "demo",
      "createdAt": 1767225600000,
      "updatedAt": 1767225600000,
      "profileStyle": null,
      "avatarUrl": null,
      "backgroundUrl": null,
      "linkedSubSystems": [
        {
          "_id": "11111111-1111-4111-8111-111111111111",
          "name": "River",
          "sideSystemId": "11111111-1111-4111-8111-111111111111"
        }
      ]
    }
  ],
  "nextCursor": null,
  "total": 0,
  "memberProfileReadByMemberId": {}
}

Example values are illustrative demo data.

Parameters

Path parameters

Name	Type	Required	Description
`friendUserId`	`string (uuid)`	Required	Identifier of the friend user.

Query parameters

Name	Type	Required	Description
`limit`	`integer`	Required	Filter or option: limit. Minimum: 1. Maximum: 100.
`cursor`	`integer`	Optional	Filter or option: cursor. Minimum: 0.
`query`	`string`	Optional	Filter or option: query. Maximum length: 200.

Response schema

200

Successful response.

Name	Type	Required	Description
`items`	`array<object>`	Required	Items returned by this request.
`items[]._id`	`string`	Required	Unique identifier.
`items[].userId`	`string`	Required	Owning account identifier.
`items[].directoryId`	`string`	Required	Containing folder identifier.
`items[].sideSystemId`	`string`	Optional	Side System Id.
`items[].subSystemId`	`string`	Optional	Sub System Id.
`items[].name`	`string`	Required	Name of the resource.
`items[].displayName`	`string`	Optional	Display name.
`items[].pronouns`	`string`	Optional	Member pronouns.
`items[].avatar`	`string`	Optional	Avatar storage reference.
`items[].about`	`string`	Optional	Member profile text.
`items[].aboutTags`	`array<string>`	Required	Tags attached to the profile text. Labels shown on the member About card (same semantics as custom-field tags).
`items[].background`	`string`	Optional	Background storage reference.
`items[].archivedAt`	`number`	Optional	Archiving time; null when active.
`items[].createdAt`	`number`	Optional	Creation time.
`items[].updatedAt`	`number`	Optional	Most recent update time.
`items[].deletedAt`	`number`	Optional	Deletion time; null when active.
`items[].purgeAt`	`number`	Optional	Purge At.
`items[].originalDirectoryId`	`string`	Optional	Original Directory Id.
`items[].profileStyle`	`null \| object`	Required	Profile presentation settings.
`items[].profileStyle.avatarRing`	`object`	Optional	Avatar Ring.
`items[].profileStyle.bannerFrame`	`object`	Optional	Banner Frame.
`items[].profileStyle.memberName`	`object`	Optional	Member Name.
`items[].profileStyle.bannerImage`	`object`	Optional	Banner Image.
`items[].profileStyle.avatarImage`	`object`	Optional	Avatar Image.
`items[].profileStyle.bannerOverlay`	`string`	Optional	Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
`items[].profileStyle.profileBackgroundPattern`	`string`	Optional	Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
`items[].profileStyle.heroLayout`	`string`	Optional	Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
`items[].profileStyle.accentColorHex`	`null \| string`	Optional	Accent Color Hex.
`items[].profileStyle.profileBackgroundFill`	`object`	Optional	Profile Background Fill.
`items[].profileStyle.pageBackgroundFill`	`object`	Optional	Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
`items[].profileStyle.panelBackgroundFill`	`object`	Optional	Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
`items[].profileStyle.panelFillAccentHex`	`null \| string`	Optional	Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
`items[].profileStyle.panelCardAccentHex`	`null \| string`	Optional	Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
`items[].avatarUrl`	`null \| string`	Required	Resolved avatar URL, or null when unavailable.
`items[].backgroundUrl`	`null \| string`	Required	Resolved background URL, or null when unavailable.
`items[].linkedSubSystems`	`array<object>`	Optional	Linked Sub Systems. Sub systems that list this member as their linked profile (`sub_systems.linked_member_id`). Distinct from `subSystemId` (member row lives inside a sub system).
`items[].linkedSubSystems[]._id`	`string`	Required	Unique identifier.
`items[].linkedSubSystems[].name`	`string`	Required	Name of the resource.
`items[].linkedSubSystems[].sideSystemId`	`string`	Required	Side System Id.
`nextCursor`	`null \| object`	Required	Cursor for the next page; null when there are no further results.
`nextCursor.index`	`number`	Required	Index.
`total`	`number`	Required	Total.
`memberProfileReadByMemberId`	`object`	Required	Member Profile Read By Member Id.

Errors

400 · JSON error

Missing friend user id.

401 · JSON error

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

403 · JSON error

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

404 · JSON error

Request failed (NOT_FOUND).

409 · JSON error

Request failed (CONFLICT).

429 · JSON error

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

Responses

Successful response.

JSON

{
  "items": [
    {
      "_id": "11111111-1111-4111-8111-111111111111",
      "userId": "11111111-1111-4111-8111-111111111111",
      "directoryId": "11111111-1111-4111-8111-111111111111",
      "sideSystemId": "11111111-1111-4111-8111-111111111111",
      "subSystemId": "11111111-1111-4111-8111-111111111111",
      "name": "River",
      "displayName": "River",
      "pronouns": "they/them",
      "avatar": "demo",
      "about": "A note from our demo system.",
      "aboutTags": [
        "A note from our demo system."
      ],
      "background": "demo",
      "createdAt": 1767225600000,
      "updatedAt": 1767225600000,
      "profileStyle": null,
      "avatarUrl": null,
      "backgroundUrl": null,
      "linkedSubSystems": [
        {
          "_id": "11111111-1111-4111-8111-111111111111",
          "name": "River",
          "sideSystemId": "11111111-1111-4111-8111-111111111111"
        }
      ]
    }
  ],
  "nextCursor": null,
  "total": 0,
  "memberProfileReadByMemberId": {}
}

Example values are illustrative demo data.

List friend members page

Parameters

Path parameters

Query parameters

Behaviour and pagination

Response schema

200

Errors

Request example

Responses

List friend members page

Parameters

Path parameters

Query parameters

Behaviour and pagination

Response schema

200

Errors

Request example

Responses