We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Web3 Services
API Overview
Configurations
Developer-Controlled Wallets
Smart Contract Platform
User-Controlled Wallets
Compliance Engine
List users
GEThttps://api.circle.com/v1/w3s/users
Get all the users under the entity, sorted by the create date DESC order.
Query parameters
pinStatus
string
Filter by the PIN status of the wallet.
securityQuestionStatus
string
Filter by the security question status of the wallet.
from
date-time
Queries items created since the specified date-time (inclusive) in ISO 8601 format.
to
date-time
Queries items created before the specified date-time (inclusive) in ISO 8601 format.
pageBefore
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
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
1 to 50
Default is 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.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": {
3 "users": [
4 {
5 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6 "createDate": "2023-01-01T12:04:05Z",
7 "pinStatus": "ENABLED",
8 "status": "ENABLED",
9 "securityQuestionStatus": "ENABLED",
10 "pinDetails": {
11 "failedAttempts": 0,
12 "lockedDate": "",
13 "lockedExpiryDate": "",
14 "lastLockOverrideDate": ""
15 },
16 "securityQuestionDetails": {
17 "failedAttempts": 0,
18 "lockedDate": "",
19 "lockedExpiryDate": "",
20 "lastLockOverrideDate": ""
21 }
22 }
23 ]
24 }
25}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
