API Reference

List wallets

gethttps://api.circle.com/v1/w3s/wallets

  • Reference
  • Playground

Retrieves a list of all wallets that fit the specified parameters.

Query parameters
address
string

Filter by the blockchain address of the wallet.

blockchain
string

Filter by blockchain.

scaCore
string

Filters results by the SCA version.

walletSetId
uuid

Filter by the wallet set.

refId
string

Filter by the reference identifier.

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    "wallets": [
4      {
5        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6        "address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
7        "blockchain": "MATIC-AMOY",
8        "createDate": "2023-01-01T12:04:05Z",
9        "updateDate": "2023-01-01T12:04:05Z",
10        "custodyType": "DEVELOPER",
11        "name": "",
12        "refId": "custom_ref_id",
13        "state": "LIVE",
14        "userId": "ext_user_id_1",
15        "walletSetId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
16        "initialPublicKey": "3eQoJ3ex6uWX3R8F1THF6Y6oBQwPYpF1X9HBM1gjqw7w",
17        "accountType": "EOA"
18      }
19    ]
20  }
21}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.