---
title: "List instance users"
method: GET
path: "/admin/users"
tags: ["Admin"]
---

# List instance users

`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`

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

## Query parameters

- `page` integer: One-based page number
- `per_page` integer: Users per page
- `search` string: 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 `200`

OK

- InstanceUserPage
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `page` integer, required: Current one-based page
  - `per_page` integer, required: Users per page
  - `total` integer, required: Total registered users
  - `total_pages` integer, required: Total number of pages
  - `users` InstanceUserResponse[], nullable, required
    - `avatar_url` string, required: Profile avatar URL
    - `created_at` string, required: Account creation time
    - `display_name` string, required: User display name
    - `email` string, required: User email address
    - `id` string, required: User ID
    - `is_admin` boolean, required: Whether the user is an instance administrator
    - `last_active_at` string, required: Most recent tracked browser session activity time
    - `organization_count` integer, required: Number of organizations the user belongs to
    - `plan_ids` string[], nullable, required: Active or trialing organization plan IDs available to the user
    - `publication_count` integer, required: Number of publications created by the user
    - `social_account_count` integer, required: Number of social accounts available through the user's workspaces
    - `workspace_count` integer, required: Number of workspaces the user can access

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/openpo/apis/openpost-api.md) · [All operations](https://skmtc.dev/openpo/apis/openpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openpo/apis/openpost-api/revisions/67d3964458a7?raw)