Skip to main content

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

Create a new group​

Create a new community group for sharing reflections. Groups can be Public, Closed, or Private, and the creator becomes the owner.

Request Body required

Group creation details including name, description, URL, and visibility

    public boolean deprecated

    Deprecated content-visibility projection. Use privacy instead.

    name string required

    Possible values: non-empty and <= 50 characters

    description string

    Possible values: <= 200 characters

    url string required

    Possible values: non-empty and <= 50 characters

    privacy string

    Possible values: [public, closed, private]

    hideFollowJoinButton boolean
Responses

Group created successfully

Schema
    success boolean required
    data object required
    isPublic boolean deprecated

    Deprecated content-visibility projection. Use privacy instead.

    id number required
    name string required
    description string required
    roomType string required
    isActive boolean required
    isVerified boolean required
    privacy string required

    Possible values: [public, closed, private]

    hideFollowJoinButton boolean required
    isOwner boolean required
    isAdmin boolean required
    ownerId string required
    postsCount number required
    membersCount number required
    url string
    avatarUrls object required
    thumb string
    original string
    createdAt date-time
    isMember boolean
    subdomain string
    country string
    membershipRequestStatus string

    Possible values: [none, pending]

    pendingMembershipRequestsCount number
Loading...