Skip to content
Optiwork API Docs

Get a group with its members

GET
/groups/{guid}
curl --request GET \
  --url https://work.optidata.cloud/api/groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

A group of the tenant together with its memberships, each carrying the member user. The synthetic all users group is addressed by its own well-known GUID and is assembled on the fly rather than stored.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

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

GUID of the group.

Responses

Section titled “ Responses ”

200

Section titled “200”

The group.

Media typeapplication/json

A group of users inside the tenant.

object
id
integer format: int64
guid

Tenant-wide identifier of the group; used in paths.

string format: uuid
name
string
description
string | null
email
string | null format: email
cuid
string
memberships

Members of the group, each with its embedded user.

Array<object>
object
key
additional properties
any
Examples
Examplegroup
{
  "id": 560,
  "guid": "a19d5670-335d-4285-8ee4-fcb54cb70faf",
  "name": "Finance",
  "description": null,
  "email": "finance@acme.example",
  "memberships": [
    {
      "id": 1201,
      "group_id": 560,
      "user": {
        "id": 15,
        "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
        "name": "Jane Doe",
        "email": "jane.doe@acme.example"
      }
    }
  ]
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

404

Section titled “404”

The resource does not exist, or does not belong to the given drive.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplemissing
{
  "message": "No query results for model [App\\Models\\Node] 99999999"
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}