Skip to main content
GET
/
v1
/
w3s
/
users
List users
curl --request GET \
  --url https://api.circle.com/v1/w3s/users \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "users": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "createDate": "2023-01-01T12:04:05Z",
        "pinStatus": "ENABLED",
        "status": "ENABLED",
        "securityQuestionStatus": "ENABLED",
        "pinDetails": {
          "failedAttempts": 123,
          "lockedDate": "2023-01-01T12:04:05Z",
          "lockedExpiryDate": "2023-01-01T12:04:05Z",
          "lastLockOverrideDate": "2023-01-01T12:04:05Z"
        },
        "securityQuestionDetails": {
          "failedAttempts": 123,
          "lockedDate": "2023-01-01T12:04:05Z",
          "lockedExpiryDate": "2023-01-01T12:04:05Z",
          "lastLockOverrideDate": "2023-01-01T12:04:05Z"
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Query Parameters

​
pinStatus
enum<string>

Filter by the PIN status of the wallet.

Available options:
ENABLED,
UNSET,
LOCKED
​
securityQuestionStatus
enum<string>

Filter by the security question status of the wallet.

Available options:
ENABLED,
UNSET,
LOCKED
​
from
string<date-time>

Queries items created since the specified date-time (inclusive) in ISO 8601 format.

Example:

"2023-01-01T12:04:05Z"

​
to
string<date-time>

Queries items created before the specified date-time (inclusive) in ISO 8601 format.

Example:

"2023-01-01T12:04:05Z"

​
pageBefore
string<uuid>

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageAfter.

​
pageAfter
string<uuid>

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageBefore.

​
pageSize
integer
default:10

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Required range: 1 <= x <= 50
​
order
enum<string>
default:DESC

Specifies the sort order of the collection by CreateDate.

Valid values:

  • ASC – Sort results in ascending order.
  • DESC – Sort results in descending order (default).
Available options:
ASC,
DESC

Response

Users retrieved successfully.

​
data
object
required