Group Invites

Operations for managing group invites

Get Group Invite

Retrieve a group invite by its ID

GET

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

Run In Postman

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123..
invite_id (required)	string ID of the group invite to retrieve	GroupInviteID_9ac42630-fe7b-4272-8e49-381f0109e261

Header Parameters

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

Responses

success

{
    "ok": {
        "data": {
            "id": "GroupInviteID_9ac42630-fe7b-4272-8e49-381f0109e261",
            "group_id": "GroupID_b810a4d0-55bb-4bbb-84cf-b044e702a10d",
            "inviter_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
            "invitee_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
            "role": "ADMIN",
            "note": "Added as ADMIN by UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
            "active_from": 1755518217882,
            "expires_at": -1,
            "created_at": 1755518217882,
            "last_modified_at": 1755518217882,
            "redeem_code": null,
            "from_placeholder_invitee": null,
            "labels": [],
            "external_id": null,
            "external_payload": null,
            "group_name": "my  group",
            "group_avatar": "",
            "invitee_name": "Owner",
            "invitee_avatar": null,
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestGetGroupInvite
Response	IResponseGetGroupInvite

---

List Group Invites

List group invites with optional filtering and pagination

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/invites/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

group_id (required)	string (GroupID) Unique identifier for a group	GroupID_b810a4d0-55bb-4bbb-84cf-b044e702a10d
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": "GroupInviteID_9ac42630-fe7b-4272-8e49-381f0109e261",
                    "group_id": "GroupID_b810a4d0-55bb-4bbb-84cf-b044e702a10d",
                    "inviter_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "invitee_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "role": "ADMIN",
                    "note": "Added as ADMIN by UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "active_from": 1755518217882,
                    "expires_at": -1,
                    "created_at": 1755518217882,
                    "last_modified_at": 1755518217882,
                    "from_placeholder_invitee": null,
                    "labels": [],
                    "redeem_code": null,
                    "external_id": null,
                    "external_payload": null,
                    "group_name": "my  group",
                    "group_avatar": "",
                    "invitee_name": "Owner",
                    "invitee_avatar": null,
                    "permission_previews": [
                        "CREATE",
                        "VIEW",
                        "EDIT",
                        "DELETE",
                        "INVITE"
                    ]
                },
                {
                    "id": "GroupInviteID_c5ee7a87-6e7b-4aa6-b409-2f4af306cba2",
                    "group_id": "GroupID_b810a4d0-55bb-4bbb-84cf-b044e702a10d",
                    "inviter_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                    "invitee_id": "PlaceholderGroupInviteeID_24a034e6-aa0e-47a4-97de-c1d8eac26f69",
                    "role": "MEMBER",
                    "note": "",
                    "active_from": 1755518224140,
                    "expires_at": -1,
                    "created_at": 1755518224637,
                    "last_modified_at": 1755518224637,
                    "from_placeholder_invitee": null,
                    "labels": [],
                    "redeem_code": "REDEEM_1755518224637",
                    "external_id": null,
                    "external_payload": null,
                    "group_name": "my  group",
                    "group_avatar": "",
                    "invitee_name": "Awaiting Anon",
                    "permission_previews": [
                        "CREATE",
                        "VIEW",
                        "EDIT",
                        "DELETE",
                        "INVITE"
                    ]
                }
            ],
            "page_size": 50,
            "total": 2,
            "direction": "ASC",
            "cursor": null
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestListGroupInvites
Response	IResponseListGroupInvites

---

Create Group Invite

Create a new group invite

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/invites/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

group_id (required)	string (GroupID) Unique identifier for a group	GroupID_b810a4d0-55bb-4bbb-84cf-b044e702a10d
invitee_id	string (UserID) Unique identifier for a user	UserID_ttko6-fa7zz-btluu-e7wxr-nx7we-schz3-ygt3h-3kqad-3z767-wjogx-iqe
role (required)	string Enum: "ADMIN","MEMBER" Role to assign to the invited user	MEMBER
active_from	integer or null <int64> Timestamp when the invite becomes active
expires_at	integer or null <int64> Timestamp when the invite expires	1672531200000
note	string or null <= 8192 characters Note about the invite	Invitation to join the project group
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes	ext-invite-001
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON	{"department": "engineering", "project": "alpha"}

Responses

success

{
    "ok": {
        "data": {
            "id": "GroupInviteID_0ce8f7de-3ea2-470d-84e5-fbe72c7e480b",
            "group_id": "GroupID_b810a4d0-55bb-4bbb-84cf-b044e702a10d",
            "inviter_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
            "invitee_id": "UserID_ttko6-fa7zz-btluu-e7wxr-nx7we-schz3-ygt3h-3kqad-3z767-wjogx-iqe",
            "role": "MEMBER",
            "note": "Invitation to join the project group",
            "active_from": 0,
            "expires_at": 1672531200000,
            "created_at": 1755519868849,
            "last_modified_at": 1755519868849,
            "labels": [],
            "external_id": "ext-invite-001",
            "external_payload": "{\"department\": \"engineering\", \"project\": \"alpha\"}",
            "group_name": "my  group",
            "group_avatar": "",
            "invitee_name": "Unknown User (UserID_ttko6-fa7zz-btluu-e7wxr-nx7we-schz3-ygt3h-3kqad-3z767-wjogx-iqe)",
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestCreateGroupInvite
Response	IResponseCreateGroupInvite

---

Update Group Invite

Update group invite

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/invites/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 (GroupInviteID) Unique identifier for a group invite	GroupInviteID_0ce8f7de-3ea2-470d-84e5-fbe72c7e480b
role	string or null Enum: "ADMIN","MEMBER" New role to assign	ADMIN
active_from	integer or null <int64> New timestamp when the invite becomes active
expires_at	string or null <= 8192 characters Public note about the contact	1672531200000
note	string or null <= 8192 characters New note about the invite	Invitation to join the project group updated as admin
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes	ext-invite-001
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON	{"department": "engineering", "project": "alpha"}

Responses

success

{
    "ok": {
        "data": {
            "id": "GroupInviteID_0ce8f7de-3ea2-470d-84e5-fbe72c7e480b",
            "group_id": "GroupID_b810a4d0-55bb-4bbb-84cf-b044e702a10d",
            "inviter_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
            "invitee_id": "UserID_ttko6-fa7zz-btluu-e7wxr-nx7we-schz3-ygt3h-3kqad-3z767-wjogx-iqe",
            "role": "ADMIN",
            "note": "Invitation to join the project group updated as admin",
            "active_from": 0,
            "expires_at": 1672531200000,
            "created_at": 1755519868849,
            "last_modified_at": 1755520730404,
            "redeem_code": null,
            "from_placeholder_invitee": null,
            "labels": [],
            "external_id": "ext-invite-001",
            "external_payload": "{\"department\": \"engineering\", \"project\": \"alpha\"}",
            "group_name": "my  group",
            "group_avatar": "",
            "invitee_name": "Unknown User (UserID_ttko6-fa7zz-btluu-e7wxr-nx7we-schz3-ygt3h-3kqad-3z767-wjogx-iqe)",
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestUpdateGroupInvite
Response	IResponseUpdateGroupInvite

---

Delete Group Invite

Delete an existing group invite

POST

https://dev.officex.app/v1/drive/{organization_id}/groups/invites/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 (GroupInviteID) Unique identifier for a group invite	GroupInviteID_0ce8f7de-3ea2-470d-84e5-fbe72c7e480b

Responses

success

{
    "ok": {
        "data": {
            "id": "GroupInviteID_0ce8f7de-3ea2-470d-84e5-fbe72c7e480b",
            "deleted": true
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestDeleteGroupInvite
Response	IResponseDeleteGroupInvite

---

Redeem Group Invite

Redeem a group invite for a specific user

POST

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

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

invite_id (required)	string (GroupInviteID) Unique identifier for a group invite	GroupInviteID_c5ee7a87-6e7b-4aa6-b409-2f4af306cba2
redeem_code (required)	string redeem code for the Invite	REDEEM_1755518224637
note	string <= 512 characters Optional note for the redemption

Responses

success

{
    "ok": {
        "data": {
            "invite": {
                "id": "GroupInviteID_c5ee7a87-6e7b-4aa6-b409-2f4af306cba2",
                "group_id": "GroupID_b810a4d0-55bb-4bbb-84cf-b044e702a10d",
                "inviter_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                "invitee_id": "UserID_apoe6-dkjea-p3gvd-oski2-4dgfx-phw7b-3uer5-lggpc-h3tun-vkzg4-5ae",
                "role": "MEMBER",
                "note": "Note from User: Redeemed by \"Anon\" on 7/23/2025, 11:07:42 PM, Prior Original Note: ",
                "active_from": 1755518224140,
                "expires_at": -1,
                "created_at": 1755518224637,
                "last_modified_at": 1755522442480,
                "redeem_code": null,
                "from_placeholder_invitee": "PlaceholderGroupInviteeID_24a034e6-aa0e-47a4-97de-c1d8eac26f69",
                "labels": [],
                "external_id": null,
                "external_payload": null
            }
        }
    }
}

error

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

Typescript Types

	type
Request	IRequestRedeemGroupInvite
Response	IResponseRedeemGroupInvite