Sign in

v1

latestOpenAPI 3.0.0AGPLv3.02026-07-14186117194.3 KB
Register

Request registration

Signup has to be enabled and require approval on the instance

post/api/v1/users/registrations/request

Request body

displayNamestring

editable name of the user, displayed in its representations

emailstring email required

email of the user, used for login or service communications

passwordstring password required
usernamestring required

immutable name of the user, used to find or mention its actor

registrationReasonstring required

reason for the user to register on the instance

Example request

{
  "channel": {
    "name": "framasoft_videos"
  },
  "username": "chocobozzz"
}

Response

successful operation

accountDisplayNamestring
channelDisplayNamestring
channelHandlestring
createdAtstring date-time
emailstring email
emailVerifiedboolean
idinteger
moderationResponsestring nullable
registrationReasonstring
updatedAtstring date-time
usernamestring

Example response

{
  "id": 42,
  "user": {
    "id": 42
  }
}