Skip to content
Optiwork API Docs

A member's pinned communities

GET
/users/{user}/categories/pinned
curl --request GET \
  --url https://feed.work.optidata.cloud/api/users/9ba64b0e-69b4-4639-a01b-4ac5c5f70a24/categories/pinned \
  --header 'Authorization: Bearer <token>'

The communities the given user has pinned. Call it for your own uuid.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
user
required
string format: uuid

UUID of the user.

Responses

Section titled “ Responses ”

200

Section titled “200”

Pinned communities.

Media typeapplication/json
Array<object>

A community (shared space) for posts.

object
id
required
integer
cuid
string
name
required
string
slug
required
string
description
string | null
emoji
string | null
cover_url
string | null
color

Hex colour, or null.

string | null
visibility
required

public — everyone in the company; private — only the people and groups it is shared with.

string
Allowed values: public private
group_id

Set when the community mirrors an Optiwork group; such communities are managed through the group, not here.

integer | null
created_at
string format: date-time
updated_at
string format: date-time
deleted_at
string | null format: date-time
pivot

Present when the community is returned as a pinned community.

object
key
additional properties
any
Examples
Exampleexample
[
  {
    "id": 864,
    "cuid": "7f3c2a10-5b8e-4d21-9c6a-0e4f1b2d3c4a",
    "name": "Announcements",
    "slug": "announcements",
    "description": "Company-wide announcements.",
    "created_at": "2026-09-02T12:10:14.000000Z",
    "updated_at": "2026-09-02T12:10:14.000000Z",
    "deleted_at": null,
    "emoji": "📣",
    "cover_url": null,
    "color": "#863bff",
    "visibility": "public",
    "group_id": null,
    "pivot": {
      "user_id": 38,
      "category_id": 864,
      "created_at": "2026-10-19T14:40:45.000000Z",
      "updated_at": "2026-10-19T14:40:45.000000Z",
      "pinned_at": "2026-10-19T14:40:45.000000Z"
    }
  }
]

401

Section titled “401”

No authentication key was sent.

Media typeapplication/json

Authentication failures use an error key.

object
error
required
string
Examples
Exampleexample
{
  "error": "JWT passport exception: Missing bearer token in request"
}

404

Section titled “404”

No matching resource, or it is not reachable through this path.

Media typeapplication/json
object
message
required
string
Examples
Exampleexample
{
  "message": "No query results for model [App\\Models\\Category] 864"
}

419

Section titled “419”

The authentication key is expired or not recognised. Get a fresh one and retry.

Media typeapplication/json

Authentication failures use an error key.

object
error
required
string
Examples
Exampleexample
{
  "error": "JWT passport expired: Passport expired"
}