List Users

GET

admin

users

List Users

curl --request GET \
  --url https://auth.nullpass.xyz/api/admin/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://auth.nullpass.xyz/api/admin/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://auth.nullpass.xyz/api/admin/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://auth.nullpass.xyz/api/admin/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://auth.nullpass.xyz/api/admin/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "users": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "username": "<string>",
      "displayName": "<string>",
      "avatar": "<string>",
      "twoFactorEnabled": true,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "totalCount": 123,
    "totalPages": 123,
    "hasMore": true
  }
}

Endpoint

GET /api/admin/users

Overview

Retrieves a paginated list of all users. Requires admin access via DROP service accessFlags or INTERNAL_SECRET.

Request

Requires authentication via Bearer token (with admin privileges) or x-internal-secret header.

Query Parameters

number

default:"1"

Page number (1-indexed)

number

default:"50"

Maximum number of users to return per page

Response

array

Array of user objects

Show User Object

string

User ID

string

User email

string

Display name (nullable)

string

Avatar path or URL (nullable)

string

Account creation timestamp (ISO string)

string

Last update timestamp (ISO string)

object

DROP service access information

Show Service Access Object

string

Access tier (default: “free”)

boolean

Premium access flag (default: false)

object

Custom access flags

object

Service-specific metadata

number

Custom storage limit in bytes (nullable)

number

Custom API key limit (nullable)

object

Pagination information

Show Pagination Object

number

Current page number

number

Items per page

number

Total number of users

number

Total number of pages

boolean

Whether there are more pages

Authentication

Admin Access via DROP Service

User must have DROP service entitlement with:

accessFlags.isNullDropTeam: true
accessFlags.nullDropTeamRole: "founder" or "dev"

Internal Secret

Alternatively, use x-internal-secret header with INTERNAL_SECRET value.

Status Codes

Success

Unauthorized

Missing or invalid authentication

Forbidden

Admin access required

Example Request

curl -X GET "https://auth.nullpass.xyz/api/admin/users?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_TOKEN"

Example Response

{
  "users": [
    {
      "id": "clx1234567890",
      "email": "user@example.com",
      "displayName": "User Name",
      "avatar": "clx1234567890/avatar_1234567890.jpg",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-02T00:00:00.000Z",
      "serviceAccess": {
        "tier": "premium",
        "isPremium": true,
        "accessFlags": {
          "isNullDropTeam": false
        },
        "metadata": {},
        "customStorageLimit": null,
        "customApiKeyLimit": null
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "totalCount": 1000,
    "totalPages": 50,
    "hasMore": true
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

default:1

limit

integer

default:50

Response

200 - application/json

List of users

users

object[]

Show child attributes

pagination

object

Show child attributes

Update User ServiceUpdate user service entitlement (admin only)

List Users

curl --request GET \
  --url https://auth.nullpass.xyz/api/admin/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://auth.nullpass.xyz/api/admin/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://auth.nullpass.xyz/api/admin/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://auth.nullpass.xyz/api/admin/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://auth.nullpass.xyz/api/admin/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "users": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "username": "<string>",
      "displayName": "<string>",
      "avatar": "<string>",
      "twoFactorEnabled": true,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "totalCount": 123,
    "totalPages": 123,
    "hasMore": true
  }
}

Get Started

Authentication

Services

Webhooks

Account Management

Service Connection

Polar Integration

Admin

Advanced

Library

Endpoint

Overview

Request

Query Parameters

Response

Authentication

Admin Access via DROP Service

Internal Secret

Status Codes

Example Request

Example Response

Authorizations

Query Parameters

Response

​Endpoint

​Overview

​Request

​Query Parameters

​Response

​Authentication

​Admin Access via DROP Service

​Internal Secret

​Status Codes

​Example Request

​Example Response

Authorizations

Query Parameters

Response

Endpoint

Overview

Request

Query Parameters

Response

Authentication

Admin Access via DROP Service

Internal Secret

Status Codes

Example Request

Example Response