Skip to main content
POST
Create workspace group

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Query Parameters

workspaceId
string
required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Minimum string length: 1

Body

application/json
name
string
required

Name of the group, up to 100 characters. Must be unique among the workspace's custom groups, ignoring case.

Required string length: 1 - 100
Example:

"Design team"

description
string | null

Short description of the group's purpose, up to 500 characters.

Maximum string length: 500
Example:

"Product designers"

role
string | null

Role every member gets: admin, editor, viewer, or no_access to block members who get their role only from this group. Leave it out, or send null, for a group that grants no role.

Example:

"editor"

member_emails
string[]

Emails of active workspace members to add, up to 200.

Maximum array length: 200
Example:

Response

The new group.

id
string
required

ID of the group.

Example:

"68b4e1d2c9a7f3001e2d4b61"

name
string
required

Name of the group.

Example:

"Design team"

source
string
required

custom for a group created in Base44, or idp for one your identity provider sends through SCIM. An idp group's name and members come from the identity provider.

Example:

"custom"

member_count
integer
required

Number of members.

Example:

12

description
string | null

Short description of the group, or null when it has none.

Example:

"Product designers"

role
string | null

Role every member gets from the group: admin, editor, viewer, or no_access. null when the group grants no role.

Example:

"editor"

unresolved_count
integer
default:0

Members your identity provider sent who don't have a Base44 account in the workspace yet. Always 0 for a custom group.

Example:

0