Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nakama Groups API

Create and manage groups (clans) and their members.

Nakama Groups API is one of 11 APIs that Nakama publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, http://127.0.0.1:7350.

2 operations 2 paths 2 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
http://127.0.0.1:7350/v2
Authentication
HTTP Basic, HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Nakama Groups API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic auth using the server key as the username and an empty password. Guards the authenticate endpoints.
  • BearerAuth — The JWT session token returned by an authenticate call, sent as Authorization: Bearer .

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Groups 2

Create and manage groups (clans) and their members.

POST
/v2/group
Create a new group with the current user as the owner.
createGroup body → 200
POST
/v2/group/{group_id}/join
Immediately join an open group, or request to join a closed one.
joinGroup 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Group (12 properties), CreateGroupRequest (6 properties). Each schema is shown below with its type and property counts.

Group
object
A group in the server.
12 properties
CreateGroupRequest
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nakama-groups-api-openapi.yml Raw ↑

Other APIs Nakama publishes across the network.

Nakama Realtime Socket API
Nakama Console API
Nakama Account API
Nakama Authentication API
Nakama Friends API
Nakama Leaderboards API
Nakama Notifications API
Nakama RPC API
Nakama Storage API
Nakama Tournaments API