Skip to content
Optiwork API Docs

List a community's shared members

GET
/categories/{category}/permissions/members
curl --request GET \
  --url https://feed.work.optidata.cloud/api/categories/864/permissions/members \
  --header 'Authorization: Bearer <token>'

Who the community is shared with — users and groups — and what each may do. Requires permission to manage the community’s sharing.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
category
required
integer

Numeric id of the community.

Responses

Section titled “ Responses ”

200

Section titled “200”

The community’s permissions.

Media typeapplication/json
Array<object>

A member (user or group) a community is shared with.

object
id
required
integer
category_id
required
integer
actions
required

What a member may do in a community.

string
Allowed values: none view interact edit manage
member_type
required

Whether a shared member is a user or a group.

string
Allowed values: App\Models\User App\Models\Group
member_id
required
integer
member

The user or group.

object
key
additional properties
any
created_at
string format: date-time
updated_at
string format: date-time
Examples
Exampleexample
[
  {
    "id": 2958,
    "category_id": 864,
    "actions": "manage",
    "created_at": "2026-10-19T14:38:00.000000Z",
    "updated_at": "2026-10-19T14:38:00.000000Z",
    "member_type": "App\\Models\\User",
    "member_id": 38,
    "member": {
      "name": "Ana Souza",
      "email": "ana.souza@example.com",
      "uuid": "9ba64b0e-69b4-4639-a01b-4ac5c5f70a24",
      "guid": null,
      "avatar_url": "https://media.optidata.cloud/avatars/ana.webp"
    }
  }
]

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"
}

403

Section titled “403”

The caller is not allowed to perform this action.

Media typeapplication/json
object
message
required
string
Examples
Exampleexample
{
  "message": "This action is unauthorized."
}

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"
}