Oumla Docs
  • Quick start
  • Introduction
  • Security
  • Networks
  • Authentication
  • Use cases
  • SDK
    • Oumla client
    • Create a Profile
    • Getting Profiles
    • Generate a Wallet
    • Getting Wallets
    • Generate Addresses
    • Getting Addresses
    • Getting Transactions
    • Sending Transactions
    • SDK reference
  • API Reference
    • Organization routes
    • Profiles routes
    • Wallet routes
    • Addresses routes
    • Transactions routes
  • Types
  • FAQs
Powered by GitBook
On this page
  1. SDK

Getting Profiles

You generated a profile for a user, Now you want to get all of the profiles you created. The following function will allow you to get all of the profiles for an organization.

Example: of how to get profiles

import { Oumla } from "@oumla/sdk";

const client = new Oumla({
   apiKey: process.env.API_KEY,
   // Additional options...
});

const profile =  await client.profiles.get();

// you can print 
   console.log(profile);
// return type is Profile

The expected output

{
    profiles: [
        {
            createdAt: '2024-01-17T09:32:29.546Z',
            updated_at: '2024-01-17T09:32:29.546Z',
            organizationId: '89a695b9-4c5f-4130-8b56-aff8010f8103',
            type: 'User',
            label: null,
            reference: 'dba1fea5-2004-4ea8-a06d-a7c7c5559b8f',
            miniWallets: [Array],
            bitcoin_balance: [Object],
            addressesCount: 0
        },
     // and the other profiles ...
    ], 
    skip: 0,
    take: 10,
    totalElements: 1,
    totalPages: 1
}
PreviousCreate a ProfileNextGenerate a Wallet

Last updated 8 months ago