Groups

Operations for managing groups

Get Group

Retrieve a group by its ID

GET

https://dev.officex.app/v1/drive/{organization_id}/groups/get/{group_id}

Run In Postman

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123
group_id (required)	string (GroupID) ID of the group to retrieve	GroupID_c18e812c-ff0b-4dd9-a28c-...

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Responses

success

{
    "ok": {
        "data": {
            "id": "GroupID_c18e812c-ff0b-4dd9-a28c-4b650565bb0d",
            "name": "group monsters",
            "owner": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
            "avatar": "",
            "private_note": "",
            "public_note": "",
            "admin_invites": [
                "GroupInviteID_81be383f-e440-4915-ade2-cbe73d626e4e"
            ],
            "member_invites": [
                "GroupInviteID_81be383f-e440-4915-ade2-cbe73d626e4e"
            ],
            "created_at": 1755494291625,
            "last_modified_at": 1755494291625,
            "drive_id": "DriveID_y6ekb-v2qhu-f5mnu-iukkc-qybbs-urd75-76sdu-4h6xc-5ewg4-kd76c-wae",
            "host_url": "https://officex.otterpad.cc",
            "labels": [],
            "external_id": null,
            "external_payload": null,
            "member_previews": [
                {
                    "user_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "name": "Owner",
                    "note": "Added as ADMIN by UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "group_id": "GroupID_c18e812c-ff0b-4dd9-a28c-4b650565bb0d",
                    "is_admin": true,
                    "invite_id": "GroupInviteID_81be383f-e440-4915-ade2-cbe73d626e4e",
                    "last_online_ms": 1755494351053
                }
            ],
            "permission_previews": [
                "CREATE",
                "EDIT",
                "DELETE",
                "INVITE",
                "VIEW"
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestGetGroup
Response	IResponseGetGroup

---

List Groups

List groups with optional filtering and pagination

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/list

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

filters	string <= 256 characters Default: "" Filter string for groups
page_size	integer [ 1 .. 1000 ] Default: 50 Number of items per page	50
direction	string Default: "ASC" Enum: "ASC" "DESC" Sort direction	ASC
cursor_up	string or null <= 256 characters Cursor for pagination (previous page)	string
cursor_down	string or null <= 256 characters Cursor for pagination (next page)	string

Responses

success

{
    "ok": {
        "data": {
            "items": [
                {
                    "id": "GroupID_b76e4405-d850-4685-88b8-c66744255724",
                    "name": "Group for All",
                    "owner": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "avatar": null,
                    "public_note": null,
                    "private_note": null,
                    "created_at": 1755438223829,
                    "last_modified_at": 1755438223829,
                    "drive_id": "DriveID_y6ekb-v2qhu-f5mnu-iukkc-qybbs-urd75-76sdu-4h6xc-5ewg4-kd76c-wae",
                    "host_url": "https://officex.otterpad.cc",
                    "external_id": null,
                    "external_payload": null,
                    "member_previews": [
                        {
                            "user_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                            "name": "Owner",
                            "note": "giftcard GiftcardSpawnOrgID_f7c7045d-fbc7-4111-9893-c4f7c0daca61 was redeemed to spawn drive with 3500000000000 cycles, owned by UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae, on timestamp_ms 1755438223829 2025-08-17T13:43:43.829Z",
                            "group_id": "GroupID_b76e4405-d850-4685-88b8-c66744255724",
                            "is_admin": true,
                            "invite_id": "GroupInviteID_6f72886f-477a-40c0-aa5b-d5f208267fcd",
                            "last_online_ms": 1755494922756
                        },
                        {
                            "user_id": "UserID_c5hjz-wpnfl-3v2jx-hglmv-6y7wm-o6zur-e6q2n-e7vp3-4z762-ajc7l-mqe",
                            "name": "manzy",
                            "note": "Auto-invited to default 'Group for All' upon contact creation.",
                            "group_id": "GroupID_b76e4405-d850-4685-88b8-c66744255724",
                            "is_admin": false,
                            "invite_id": "GroupInviteID_e8479d67-0806-4ee3-bb75-6ff5245ee21e",
                            "last_online_ms": 0
                        }
                    ],
                    "permission_previews": [
                        "CREATE",
                        "VIEW",
                        "EDIT",
                        "DELETE",
                        "INVITE"
                    ]
                },
                {
                    "id": "GroupID_c18e812c-ff0b-4dd9-a28c-4b650565bb0d",
                    "name": "group monsters",
                    "owner": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "avatar": "",
                    "public_note": "",
                    "private_note": "",
                    "created_at": 1755494291625,
                    "last_modified_at": 1755494291625,
                    "drive_id": "DriveID_y6ekb-v2qhu-f5mnu-iukkc-qybbs-urd75-76sdu-4h6xc-5ewg4-kd76c-wae",
                    "host_url": "https://officex.otterpad.cc",
                    "external_id": null,
                    "external_payload": null,
                    "member_previews": [
                        {
                            "user_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                            "name": "Owner",
                            "note": "Added as ADMIN by UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                            "group_id": "GroupID_c18e812c-ff0b-4dd9-a28c-4b650565bb0d",
                            "is_admin": true,
                            "invite_id": "GroupInviteID_81be383f-e440-4915-ade2-cbe73d626e4e",
                            "last_online_ms": 1755494922756
                        }
                    ],
                    "permission_previews": [
                        "CREATE",
                        "VIEW",
                        "EDIT",
                        "DELETE",
                        "INVITE"
                    ]
                }
            ],
            "page_size": 2,
            "total": 2,
            "direction": "ASC",
            "cursor": ""
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestListGroups
Response	IResponseListGroups

---

Create Group

Create a new group

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/create

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

name	string <= 256 characters Name for the contact	Product Design Team
avatar	string or null <= 2048 characters Profile picture URL
public_note	string or null <= 8192 characters Public note about the contact	Core product development group
private_note	string or null <= 8192 characters Private note about the contact	Primary contact for urgent issues
host_url	string or null <= 4096 characters URL endpoint for the group
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON	{"department": "engineering", "project": "alpha"}

Responses

success

{
    "ok": {
        "data": {
            "id": "GroupID_dfa08703-c707-495c-8ffd-996ab4c74ba9",
            "name": "Product Design Team",
            "owner": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
            "avatar": "",
            "public_note": "Core product development group",
            "created_at": 1755495309551,
            "last_modified_at": 1755495309551,
            "drive_id": "DriveID_y6ekb-v2qhu-f5mnu-iukkc-qybbs-urd75-76sdu-4h6xc-5ewg4-kd76c-wae",
            "host_url": "https://officex.otterpad.cc",
            "labels": [],
            "external_id": "",
            "external_payload": "{\"department\": \"engineering\", \"project\": \"alpha\"}",
            "admin_invites": [],
            "member_invites": [],
            "member_previews": [
                {
                    "user_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "name": "Owner",
                    "note": "Added as ADMIN by UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "avatar": null,
                    "group_id": "GroupID_dfa08703-c707-495c-8ffd-996ab4c74ba9",
                    "is_admin": true,
                    "invite_id": "GroupInviteID_55251152-e7c9-4443-92f6-9c4959baae2b",
                    "last_online_ms": 1755495309539
                }
            ],
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestCreateGroup
Response	IResponseCreateGroup

---

Update Group

Update group

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/update

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

id (required)	string (GroupID) Unique identifier for a group	GroupID_dfa08703-c707-495c-8ffd-996ab4c74ba9
name	string <= 256 characters Name for the contact	Product Design Team
avatar	string or null <= 2048 characters Profile picture URL
public_note	string or null <= 8192 characters Public note about the contact	Core product development group
private_note	string or null <= 8192 characters Private note about the contact	Updated group structure
host_url	string or null <= 4096 characters URL endpoint for the group
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON	{"department": "engineering", "project": "alpha", "updated": true}

Responses

success

{
    "ok": {
        "data": {
            "id": "GroupID_dfa08703-c707-495c-8ffd-996ab4c74ba9",
            "name": "Product & Design",
            "owner": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
            "avatar": "",
            "private_note": "Updated group structure",
            "public_note": "Core product development group",
            "admin_invites": [
                "GroupInviteID_55251152-e7c9-4443-92f6-9c4959baae2b"
            ],
            "member_invites": [
                "GroupInviteID_55251152-e7c9-4443-92f6-9c4959baae2b"
            ],
            "created_at": 1755495309551,
            "last_modified_at": 1755495965034,
            "drive_id": "DriveID_y6ekb-v2qhu-f5mnu-iukkc-qybbs-urd75-76sdu-4h6xc-5ewg4-kd76c-wae",
            "host_url": "https://officex.otterpad.cc",
            "labels": [],
            "external_id": "",
            "external_payload": "{\"department\": \"engineering\", \"project\": \"alpha\", \"updated\": true}",
            "member_previews": [
                {
                    "user_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "name": "Owner",
                    "note": "Added as ADMIN by UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "avatar": null,
                    "group_id": "GroupID_dfa08703-c707-495c-8ffd-996ab4c74ba9",
                    "is_admin": true,
                    "invite_id": "GroupInviteID_55251152-e7c9-4443-92f6-9c4959baae2b",
                    "last_online_ms": 1755495965010
                }
            ],
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestUpdateGroup
Response	IResponseUpdateGroup

---

Delete Group

Delete an existing group

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/delete

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

id (required)	string (GroupID) Unique identifier for a group	GroupID_dfa08703-c707-495c-8ffd-996ab4c74ba9

Responses

success

{
    "ok": {
        "data": {
            "id": "GroupID_dfa08703-c707-495c-8ffd-996ab4c74ba9",
            "deleted": true
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestDeleteGroup
Response	IResponseDeleteGroup

---

Validate Member

Verify if a user belongs to a specific group

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/validate

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

user_id (required)	string (GroupID) Unique identifier for a user	UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae
group_id (required)	string (GroupID) Unique identifier for a group	GroupID_c18e812c-ff0b-4dd9-a28c-4b650565bb0d

Responses

success

{
    "ok": {
        "data": {
            "is_member": true,
            "group_id": "GroupID_c18e812c-ff0b-4dd9-a28c-4b650565bb0d",
            "user_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae"
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestValidateGroupMember
Response	IResponseValidateGroupMember