Skip to main content
GET
List users
Use the filter query parameter to return only active users (user.isActive()) or only suspended users (user.isSuspended()). Omit the filter to return both. Users in any other state aren’t included. This endpoint supports pagination. Use max_page_size to set the number of users returned per page (100 by default, up to 1000). Pass the next_page_token from each response in the page_token query parameter to fetch the next page, along with the same filter value.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token authentication. Request an access token from the OAuth token endpoint using the client credentials for the OAuth application in your 1Password account, then include it in the Authorization header of every request as Bearer <token>. Access tokens expire after 15 minutes (900 seconds).

Headers

User-Agent
string

An identifiable user agent for your integration, in the format <CompanyOrProductName>/<version>, so requests can be attributed to a specific integration for support, troubleshooting, and usage analytics.

Path Parameters

account
string
required

The unique identifier of the 1Password account, a 26-character uppercase ID. A malformed ID returns 400 Bad Request.

Required string length: 26

Query Parameters

filter
string

Filter users by state. Supported values (case-sensitive): user.isActive() or user.isSuspended(). Omit or leave empty to return both active and suspended users. Any other value returns 400 Bad Request with an invalid_argument error.

max_page_size
integer<int32>
default:100

The maximum number of users to return per page. Defaults to 100 when omitted or set to 0. The maximum is 1000; values greater than 1000 are limited to 1000, and negative values return 400 Bad Request. Ignored when page_token is provided.

Required range: 0 <= x <= 1000
page_token
string

The pagination token that identifies the page of results to return. Use the next_page_token value from a previous response, and send the same filter value as the original request. Tokens are opaque and don't expire.

Response

A paginated list of users in the account.

The paginated list of users.

results
object[]

The list of users returned for this page. Only active and suspended users are included.

next_page_token
string

An opaque token to retrieve the next page of results. Pass it in the page_token query parameter of the next request. Omitted when there are no more results. A page with no results is returned as an empty object ({}).