Admin

List instance users

Returns a newest-first, paginated directory of users visible only to an instance administrator.

get/admin/users

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/admin/users
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Query parameters

pageinteger

One-based page number

per_pageinteger

Users per page

searchstring

Case-insensitive email or display-name search

sort'created_at' | 'email' | 'display_name' | 'last_active_at' | 'workspace_count' | 'publication_count'

Directory sort field

direction'asc' | 'desc'

Directory sort direction

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

pageinteger required

Current one-based page

per_pageinteger required

Users per page

totalinteger required

Total registered users

total_pagesinteger required

Total number of pages

Example response

{
  "$schema": "https://example.com/api/v1/schemas/InstanceUserPage.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.