Skip to main content
GET
/
api
/
users
curl -X GET "https://oro-tradebook-devnet.up.railway.app/api/users?partnerId=1&page=1&limit=20" \
  -H "x-api-key: your-api-key"

{
  "success": true,
  "data": {
    "users": [
      {
        "userId": "user-pda-1",
        "userPda": "user-pda-1",
        "kycHash": "hash123",
        "userWalletAddress": "wallet-address",
        "metadata": {"referenceId": "user-123"},
        "balancesManagedByProgram": {
          "gold": {"amount": 1.5, "valueUsd": 7500}
        },
        "createdAt": "2024-01-15T10:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalItems": 1,
      "totalPages": 1
    }
  }
}

​
Overview

Retrieves a paginated list of users belonging to the authenticated partner. Authorization Required: Any partner scope (PARTNER_EXECUTIVE_AUTHORITY, PARTNER_UPDATE_AUTHORITY, or PARTNER_WITHDRAWAL_AUTHORITY)

​
Headers

​
x-api-key
string
required
Your API key for authentication

​
Query Parameters

​
partnerId
number
required
The partner ID to list users for
​
page
number
default:"1"
Page number for pagination
​
limit
number
default:"20"
Items per page
​
sortBy
string
default:"createdAt"
Field to sort by
​
sortDir
string
default:"desc"
Sort direction: asc or desc
​
filter
string
JSON-encoded filter criteria. Example: {"hasWalletAddress": true}

​
Response

​
success
boolean
Whether the request was successful
​
data
object
curl -X GET "https://oro-tradebook-devnet.up.railway.app/api/users?partnerId=1&page=1&limit=20" \
  -H "x-api-key: your-api-key"

{
  "success": true,
  "data": {
    "users": [
      {
        "userId": "user-pda-1",
        "userPda": "user-pda-1",
        "kycHash": "hash123",
        "userWalletAddress": "wallet-address",
        "metadata": {"referenceId": "user-123"},
        "balancesManagedByProgram": {
          "gold": {"amount": 1.5, "valueUsd": 7500}
        },
        "createdAt": "2024-01-15T10:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalItems": 1,
      "totalPages": 1
    }
  }
}