Skip to main content
POST
Create a group

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new Group resource

description
string | null
hasPriority
boolean | null
default:true
hasDueDate
boolean | null
default:false
hasTypes
boolean | null
default:true
hasStatus
boolean | null
default:true
hasEvents
boolean | null
default:false
hasDiscussion
boolean | null
default:false
hasFiles
boolean | null
default:false
isJoinable
boolean | null
default:false
onlyAdminsCanPost
boolean | null
onlyAdminsCanCreateEvents
boolean | null
onlyAdminsCanUploadFiles
boolean | null
onlyAdminsCanAddMembers
boolean | null
includesAllMembers
boolean | null
category
string<iri-reference> | null
Example:

"/api/v1/group_categories/1"

isProject
boolean | null
default:false
name
string
status
string | null
unitType
string<iri-reference> | null
Example:

"/api/v1/unit_types/1"

emoji
string | null

Response

Group resource created

owner
object | null
description
string | null
hasPriority
boolean | null
default:true
hasDueDate
boolean | null
default:false
hasTypes
boolean | null
default:true
hasStatus
boolean | null
default:true
hasEvents
boolean | null
default:false
hasDiscussion
boolean | null
default:false
hasFiles
boolean | null
default:false
isJoinable
boolean | null
default:false
onlyAdminsCanPost
boolean | null
onlyAdminsCanCreateEvents
boolean | null
onlyAdminsCanUploadFiles
boolean | null
onlyAdminsCanAddMembers
boolean | null
includesAllMembers
boolean | null
category
object | null
isProject
boolean | null
default:false
id
integer
read-only
name
string
dateCreated
string<date-time>
dateEnded
string<date-time> | null
status
string | null
unitType
object | null
logo
string | null
userType
string<iri-reference> | null
Example:

"/api/v1/roles/1"

isRoleGroup
boolean | null
activeMemberCount
integer
emoji
string | null