Ospree docs
API ReferenceWebsiteSocials
  • GETTING STARTED
    • Intro to Ospree
      • What is the Travel Rule?
      • Types of Travel Rule transfers
      • What is a wallet address?
      • What is an Account at Ospree?
      • What is a VASP or CASP?
    • Account
      • Understand user roles
      • Add and manage users
      • Change your password
      • Set up two-factor authentication (2FA)
      • Log in with 2FA-enabled
  • DASHBOARD
    • Overview
    • Travel Rule
      • Start a transfer
      • Search and filter transfers
      • Interoperability
      • Self-hosted wallets
    • Accounts Directory
      • Create an account
      • Edit an account
      • Create a recipient
      • Edit a recipient
      • Add a new wallet
      • VASPs
        • Search and filter
        • Request a VASP
  • OSPREE API
    • Overview
    • API integration flows
    • Authentication
    • Breaking Changes
    • Errors
    • Token Identifier
    • Webhooks
      • Webhook events
      • Webhook request
      • Webhook management
    • Travel Rule
      • Create Transfer
      • List Transfers
      • Retrieve Transfer
      • Update Transfer
      • Action Transfer
    • Accounts Directory
      • Create Account
      • List Accounts
      • Retrieve Account
      • Update Account
      • Remove account
      • Search account
      • Retrieve VASP
      • Search VASP
      • List VASPs
    • Blockchain Analytics
      • Create Address
      • List Addresses
      • Retrieve Address
      • Assign an address to account
      • Create Transaction (Beta)
      • List Transactions (Beta)
      • Retrieve Transaction (Beta)
  • Resources and Help
    • Data pre-validation
    • Sunrise Issue
Powered by GitBook
On this page
  1. OSPREE API
  2. Accounts Directory

List Accounts

GET /api/v2/directory/accounts

This endpoint retrieves a list of all accounts within the directory.

Query Parameters

Name
Type
Description
Required

start_range

string

Starting point for specified data range. Example:2020-12-09

end_range

string

Ending point for specified data range. Example:2023-12-09

page

integer

The page number. Minimum: 1. Default: 1

size

Integer

The page size. Minimum: 1. Maximum: 100. Default: 50.

sort

string

Criteria for result sorting.

Default: -created. Example:

-last_modified

account_type

string

Type of the account. Either individual or entity

account_category

string

Category of the account. Either customer or recipient.

Response

{
    "status": "success",
    "data": {
        "items": [
            {
                "reference_id": "Mary",
                "account_type": "Individual",
                "name": "Mary Jane",
                "account_category": "customer",
                "email": "mary@example.com",
                "created": "2024-09-20T07:16:05+00:00",
                "last_modified": "2024-09-20T07:16:05+00:00"
            },
            {
                "reference_id": "Ospree",
                "account_type": "Entity",
                "name": "Ospree Ltd.",
                "account_category": "customer",
                "email": "ospree@example.com",
                "created": "2024-09-18T09:52:51+00:00",
                "last_modified": "2024-09-18T09:52:51+00:00"
            },
            {
                "reference_id": "John123",
                "account_type": "Individual",
                "name": "John Doe",
                "account_category": "recipient",
                "email": "john@example.com",
                "created": "2024-09-18T09:52:36+00:00",
                "last_modified": "2024-09-18T09:52:36+00:00"
            },
            {
                "reference_id": "NewBusiness123",
                "account_type": "Entity",
                "name": "New Business Ltd.",
                "account_category": "recipient",
                "email": "newbusiness@example.com",
                "created": "2024-09-18T09:52:14+00:00",
                "last_modified": "2024-09-18T09:52:14+00:00"
            }
        ],
        "pagination": {
            "total": 4,
            "size": 10,
            "page": 1
        }
    }
}

Last updated 1 month ago