> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List accounts
> List accounts owned by a user.
export const RestEndpointSubjects = ({subjects = []}) => {
const subjectToIconMap = {
'client': 'browser',
'user:individual': 'user',
'user:business': 'briefcase'
};
if (subjects.length === 0) {
return null;
}
return <>
{subjects.map(subject =>
{subject}
)}
;
};
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json get /core/accounts
openapi: 3.1.0
info:
version: 0.1.0
title: Core API
description: >-
The Core API provides essential building blocks that empower businesses to
embed financial services into their applications.
contact:
name: Uphold API Team
email: developers@uphold.com
url: https://developer.uphold.com
servers:
- url: https://api.enterprise.sandbox.uphold.com
description: Sandbox
- url: https://api.enterprise.uphold.com
description: Production
security:
- OAuth2: []
tags:
- name: Authentication
description: Authentication.
- name: Countries
description: Countries.
- name: Users
description: Users.
- name: KYC
description: Individual User's KYC.
- name: KYB
description: Business User's KYB.
- name: Capabilities
description: User capabilities.
- name: Terms of service
description: User terms of service.
- name: Files
description: Files.
- name: Assets
description: Assets, networks and rails.
- name: Accounts
description: Accounts.
- name: External accounts
description: External accounts.
- name: Transactions
description: Transactions.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/accounts:
get:
tags:
- Accounts
summary: List accounts
description: List accounts owned by a user.
operationId: core.list-accounts
parameters:
- $ref: '#/components/parameters/list-accounts-asset-code-filter'
- $ref: '#/components/parameters/pagination-per-page'
responses:
'200':
$ref: '#/components/responses/list-accounts-response'
security:
- OAuth2:
- core.accounts:read
components:
parameters:
list-accounts-asset-code-filter:
name: asset
description: Filter accounts by asset code.
in: query
style: form
explode: false
required: false
schema:
type: array
maxItems: 100
uniqueItems: true
items:
type: string
minLength: 1
examples:
BTC Asset:
value:
- BTC
pagination-per-page:
name: perPage
description: The number of items per page.
in: query
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 10
examples:
10 Items Per Page:
value: 10
responses:
list-accounts-response:
description: Accounts retrieved.
content:
application/json:
schema:
type: object
properties:
accounts:
type: array
items:
$ref: '#/components/schemas/account'
pagination:
$ref: '#/components/schemas/pagination'
required:
- accounts
- pagination
examples:
Accounts Retrieved:
value:
accounts:
- id: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
label: My BTC account
asset: BTC
balance:
total: '0.0015'
available: '0.0015'
createdAt: '2024-06-01T00:00:00.000Z'
updatedAt: '2024-07-15T00:00:00.000Z'
- id: 38778db4-7ad5-4353-88b8-07e93eb1e02e
ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
label: My ETH account
asset: ETH
balance:
total: '0.04'
available: '0.039'
createdAt: '2024-07-01T00:00:00.000Z'
updatedAt: '2024-07-10T00:00:00.000Z'
pagination:
first: >-
https://api.enterprise.uphold.com/core/accounts?page=1&perPage=2
next: >-
https://api.enterprise.uphold.com/core/accounts?page=2&perPage=2
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
schemas:
account:
type: object
properties:
id:
description: The id of the account.
type: string
format: uuid
ownerId:
description: The id of the user that owns the account.
type: string
format: uuid
label:
description: The label of the account.
type: string
asset:
description: The asset in which the account is denominated.
type: string
balance:
description: The balance of the account.
type: object
properties:
total:
description: The total balance of the account.
type: string
available:
description: The available balance of the account.
type: string
required:
- total
- available
createdAt:
description: The time at which the account was created.
type: string
format: date-time
updatedAt:
description: The last time at which the account was updated.
type: string
format: date-time
required:
- id
- ownerId
- label
- asset
- balance
- createdAt
- updatedAt
pagination:
description: The pagination information.
type: object
properties:
first:
description: The URL to the first set of results.
type: string
format: uri
prev:
description: The URL to the previous set of results.
type: string
format: uri
next:
description: The URL to the next set of results.
type: string
format: uri
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authentication.
flows:
clientCredentials:
tokenUrl: /core/oauth2/token
scopes:
core.users:act-on-behalf-of: Grants access to act on behalf of a user
core.users:create: Grants access to create users
core.users:read: Grants access to view users
core.users:delete: Grants access to delete users
core.users.metadata:read: Grants access to view user metadata
core.users.metadata:write: Grants access to modify user metadata
core.kyc:read: Grants access to view KYC processes
core.kyc.profile:update: Grants access to update profile KYC process
core.kyc.address:update: Grants access to update address KYC process
core.kyc.email:update: Grants access to update email KYC process
core.kyc.phone:update: Grants access to update phone KYC process
core.kyc.identity:update: Grants access to update identity KYC process
core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
core.kyc.tax-details:update: Grants access to update tax details KYC process
core.capabilities:read: Grants access to view user capabilities
core.terms-of-service:read: Grants access to view terms of service
core.terms-of-service:accept: Grants access to accept terms of service
core.files:create: Grants access to create files
core.files:read: Grants access to view files
core.files.metadata:read: Grants access to view files metadata
core.files.metadata:write: Grants access to modify files metadata
core.accounts:create: Grants access to create accounts
core.accounts:read: Grants access to view accounts
core.accounts:update: Grants access to update accounts
core.accounts:archive: Grants access to archive accounts
core.accounts:deposit-method: >-
Grants access to deposit method needed for depositing into
accounts
core.accounts:use-test-helpers: Grants access to test helpers of accounts
core.accounts.metadata:read: Grants access to view accounts metadata
core.accounts.metadata:write: Grants access to modify accounts metadata
core.assets:use-test-helpers: Grants access to test helpers of assets
core.external-accounts:create: Grants access to create external accounts
core.external-accounts:read: Grants access to view external accounts
core.external-accounts:update: Grants access to update external accounts
core.external-accounts:delete: Grants access to delete external accounts
core.external-accounts.metadata:read: Grants access to view external accounts metadata
core.external-accounts.metadata:write: Grants access to modify external accounts metadata
core.transactions:create: Grants access to commit quotes
core.transactions:read: Grants access to view transactions
core.transactions.metadata:read: Grants access to view transactions metadata
core.transactions.metadata:write: Grants access to modify transactions metadata
core.transactions.requests-for-information:read: Grants access to view transactions requests for information
core.transactions.requests-for-information:update: Grants access to update transactions requests for information
core.portfolio:read: >-
Grants access to view portfolio overview, performance, and
historical balance
core.statements:read: Grants access to read statements
core.webhooks:management-link: Grants access to create webhook management links
````