List pinned messages
Returns pinned messages accessible to the API key’s account.
GET
/api/v1/messaging/channels/{channelId}/pinsmessaging: read1,000 requests/minute/key · all plansActive API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.
Message storage
Message text is encrypted at rest and decrypted for authorised requests. Channel access is restricted to spaces owned by the API key’s account; missing or inaccessible channels return 404. Editing or deleting a message additionally checks its author and can return 403.
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
channelId | string (uuid) | Required | Identifier of the channel. |
Response schema
200
Successful response.
| Name | Type | Required | Description |
|---|---|---|---|
items | array<object> | Required | Items returned by this request. |
items[].pinId | string | Required | Pin Id. |
items[].messageId | string | Required | Message Id. |
items[].channelId | string | Required | Channel Id. |
items[].spaceId | string | Required | Space Id. |
items[].pinnedAt | number | Required | Pinned At. |
items[].pinnedByUserId | string | Required | Pinned By User Id. |
items[].availability | string | Required | Availability. Allowed values: "deleted", "available", "unavailable". |
items[].authorMemberDisplayName | null | string | Required | Author Member Display Name. |
items[].authorMemberAvatarUrl | null | string | Required | Author Member Avatar Url. |
items[].authorMemberProfileStyle | null | object | Required | Author Member Profile Style. |
items[].authorMemberProfileStyle.avatarRing | object | Optional | Avatar Ring. |
items[].authorMemberProfileStyle.bannerFrame | object | Optional | Banner Frame. |
items[].authorMemberProfileStyle.memberName | object | Optional | Member Name. |
items[].authorMemberProfileStyle.bannerImage | object | Optional | Banner Image. |
items[].authorMemberProfileStyle.avatarImage | object | Optional | Avatar Image. |
items[].authorMemberProfileStyle.bannerOverlay | string | Optional | Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid". |
items[].authorMemberProfileStyle.profileBackgroundPattern | string | Optional | Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise". |
items[].authorMemberProfileStyle.heroLayout | string | Optional | Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left". |
items[].authorMemberProfileStyle.accentColorHex | null | string | Optional | Accent Color Hex. |
items[].authorMemberProfileStyle.profileBackgroundFill | object | Optional | Profile Background Fill. |
items[].authorMemberProfileStyle.pageBackgroundFill | object | Optional | Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient). |
items[].authorMemberProfileStyle.panelBackgroundFill | object | Optional | Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient). |
items[].authorMemberProfileStyle.panelFillAccentHex | null | string | Optional | Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+). |
items[].authorMemberProfileStyle.panelCardAccentHex | null | string | Optional | Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+). |
items[].snippet | string | Required | Snippet. |
items[].createdAt | null | number | Required | Creation time. |
items[].editedAt | null | number | Required | Edited At. |
totalCount | number | Required | Total Count. |
Errors
400· JSON errorRequest failed (BAD_REQUEST).
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires messaging: read; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
409· JSON errorconflict.
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
500· JSON errorinternal server error.
503· JSON errorObject storage is not configured. Set MinIO (or compatible S3) env vars to upload files.
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request GET 'https://floralitys.com/api/v1/messaging/channels/11111111-1111-4111-8111-111111111111/pins' \
--header "Authorization: Bearer $FLORALITY_KEY"Responses
Successful response.
{
"items": [
{
"pinId": "11111111-1111-4111-8111-111111111111",
"messageId": "11111111-1111-4111-8111-111111111111",
"channelId": "11111111-1111-4111-8111-111111111111",
"spaceId": "11111111-1111-4111-8111-111111111111",
"pinnedAt": 1767225600000,
"pinnedByUserId": "11111111-1111-4111-8111-111111111111",
"availability": "deleted",
"authorMemberDisplayName": null,
"authorMemberAvatarUrl": null,
"authorMemberProfileStyle": null,
"snippet": "demo",
"createdAt": null,
"editedAt": null
}
],
"totalCount": 0
}Example values are illustrative demo data.