List registrations

GET

https://peertube2.cpy.re/api/v1/users/registrations

List registrations

curl -X GET 'https://peertube2.cpy.re/api/v1/users/registrations?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/users/registrations?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/users/registrations?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "state": {
        "id": 1,
        "label": "string"
      },
      "registrationReason": "string",
      "moderationResponse": "string",
      "username": "string",
      "email": "user@example.com",
      "emailVerified": true,
      "accountDisplayName": "string",
      "channelHandle": "string",
      "channelDisplayName": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "user": {
        "id": 42
      }
    }
  ]
}

Parameters

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

searchstringquery

sortstring-createdAtcreatedAtstate-statequery

stateOneOfArray<UserRegistrationState>123query

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<UserRegistration>

Show child attributes

idid>= 1

Example

stateobject

Show child attributes

idUserRegistrationState123

The registration state (Pending = 1, Rejected = 2, Accepted = 3)

labelstring

registrationReasonstring

moderationResponsestring | null

usernamestring

emailstring<email>

emailVerifiedboolean

accountDisplayNamestring

channelHandlestring

channelDisplayNamestring

createdAtstring<date-time>

updatedAtstring<date-time>

userobject | null

If the registration has been accepted, this is a partial user object created by the registration

Show child attributes

idid>= 1

Example

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin, moderator

Docs by Sourcey