---
search:
  tags:
    - Portfolio
    - GET
seo:
  description: >-
    Returns the caller's non-deleted accounts, including accounts whose setup is
    pending or… Reference for the GET /portfolio/accounts endpoint in the REST
    API.
sidebar:
  label: List Accounts
  badge: GET
title: List Accounts
type: openapi-operation
---
Returns the caller's non-deleted accounts, including accounts whose setup is pending or failed. A key restricted to one account returns only that account.

### Endpoint

- Method and path: `GET /portfolio/accounts`
- Operation ID: `listAccounts`
- API reference: [GET /portfolio/accounts](/api-reference/rest/portfolio/list-accounts)
- Complete specification: [OpenAPI (YAML)](/openapi.yml)
- Spec location (JSON Pointer): `#/paths/~1portfolio~1accounts/get`

#### Authorization

- Accepted credentials: `UDX-Access-Key` header and `UDX-Access-Timestamp` header and `UDX-Access-Signature` header; or Bearer token in `Authorization`
- Details: [Authentication](/reference/authentication)

#### Parameters

```yaml
- $ref: "#/components/parameters/VersionHeader"
- $ref: "#/components/parameters/PaginationLimit"
- $ref: "#/components/parameters/PaginationPage"
- $ref: "#/components/parameters/AccountsSort"
- $ref: "#/components/parameters/PaginationOrder"
```


#### Responses

##### `200`

The current user's non-deleted accounts with active grants.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/json`

Schema:

```yaml
$ref: "#/components/schemas/AccountsListResponse"
```

Example: No granted accounts

```json
{
  "accounts": [],
  "next_page_url": null
}
```

Example: Multiple granted accounts

```json
{
  "accounts": [
    {
      "id": "6820943174116859281",
      "name": "Primary Desk",
      "status": "active",
      "reference_number": "UDX4839201656",
      "client_account_id": null
    },
    {
      "id": "9214170797177585522",
      "name": "New Desk",
      "status": "pending",
      "reference_number": "UDX7051938824",
      "client_account_id": null
    }
  ],
  "next_page_url": null
}
```

##### `400`

The request doesn't conform to this spec.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Invalid request parameters

```json
{
  "type": "urn:udx:problem:invalid-request-parameters",
  "title": "Bad Request",
  "status": 400,
  "detail": "invalid request parameters",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

Example: Unknown UDX-Version

```json
{
  "type": "urn:udx:problem:unknown-version",
  "title": "Bad Request",
  "status": 400,
  "detail": "unknown UDX-Version \"1999-01-01\"; supported versions: 2026-07-15",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `401`

No valid credential was provided.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Authentication failed

```json
{
  "type": "urn:udx:problem:invalid-authentication-credentials",
  "title": "Unauthorized",
  "status": 401,
  "detail": "invalid authentication credentials",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `403`

The credential lacks the read scope.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Insufficient permissions

```json
{
  "type": "urn:udx:problem:insufficient-permissions",
  "title": "Forbidden",
  "status": 403,
  "detail": "insufficient permissions",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `429`

The member rate limit was exceeded.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
Retry-After:
  $ref: "#/components/headers/RetryAfter"
Cache-Control:
  $ref: "#/components/headers/NoStore"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Example

```json
{
  "type": "urn:udx:problem:member-rate-limit-exceeded",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "this member has temporarily exceeded its request rate",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `500`

Something went wrong on UDX's side.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Internal server error

```json
{
  "type": "urn:udx:problem:internal-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `503`

Request admission is unavailable.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
Cache-Control:
  $ref: "#/components/headers/NoStore"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Admission temporarily unavailable

```json
{
  "type": "urn:udx:problem:request-admission-unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "request admission is temporarily unavailable",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```


#### Referenced definitions

The references in the excerpts above resolve to these definitions in the complete specification.

##### `#/components/headers/VersionHeader`

```yaml
description: API version used for this response.
schema:
  type: string
  maxLength: 10
  description: A dated API version (YYYY-MM-DD).
  example: 2026-07-15
```

##### `#/components/schemas/AccountsListResponse`

```yaml
type: object
description: A page of accounts available to the current user.
required:
  - accounts
  - next_page_url
properties:
  accounts:
    type: array
    maxItems: 100
    description: One page of accounts connected by active grants.
    items:
      $ref: "#/components/schemas/Account"
  next_page_url:
    $ref: "#/components/schemas/NextPageURL"
```

##### `#/components/schemas/Account`

```yaml
type: object
description: An account belonging to the caller's member.
required:
  - id
  - name
  - status
  - client_account_id
properties:
  id:
    $ref: "#/components/schemas/EntityId"
  name:
    type: string
    minLength: 1
    maxLength: 200
    description: Human-readable name for the account.
  status:
    type: string
    description: Readiness of the account for this user.
    enum:
      - pending
      - active
      - failed
  reference_number:
    type:
      - string
      - "null"
    description: Reference number for accounting.
    example: UDX4839201656
  client_account_id:
    type:
      - string
      - "null"
    maxLength: 64
    description: The identifier you supplied when creating this account.
    example: customer-3f6b2a9e
```

##### `#/components/schemas/EntityId`

```yaml
type: string
minLength: 1
description: An exchange-assigned identifier. Treat it as an opaque, stable key with no internal structure.
example: "6820943174116859281"
```

##### `#/components/schemas/NextPageURL`

```yaml
type:
  - string
  - "null"
format: uri-reference
maxLength: 4096
pattern: ^/[^/\s#][^\s#]*$
description: Root-relative URL for the next page. Null when there are no more items.
example: /api_keys?limit=10&order=desc&page=eyJ2IjoxLCJzIjoiMjAyNi0wNi0wMVQxMjowMDowMC4wMDAwMDBaIiwiaWQiOiIzNTE3NDU2MjI5NjM0MTg1NjQ2In0&sort=created_at
```

##### `#/components/schemas/ProblemDetails`

```yaml
type: object
description: An RFC 9457 machine-readable error, returned on every non-2xx response. The response's Content-Language header identifies the language used by title and detail, and Vary includes Accept-Language.
required:
  - type
  - title
  - status
properties:
  type:
    type: string
    format: uri-reference
    maxLength: 2048
    description: A stable URN identifying the kind of problem, for example urn:udx:problem:insufficient-permissions. Branch on it rather than on the localized detail. It is an identifier, not a URL to dereference.
  title:
    type: string
    maxLength: 40
    example: Bad Request
    description: A localized, human-readable summary of the error category. Stable for a given status code and resolved language — clients must not use it as a machine-readable discriminator.
  status:
    type: integer
    example: 400
    description: The HTTP status code, repeated from the response itself.
  detail:
    type: string
    maxLength: 500
    example: malformed request body
    description: A localized, human-readable explanation specific to this occurrence. Clients must not parse it for machine-readable information.
  instance:
    type: string
    format: uri-reference
    maxLength: 100
    example: urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef
    description: An identifier for this specific occurrence, so it can be correlated with server-side logs if you need to report it.
```

##### `#/components/headers/RetryAfter`

```yaml
description: Whole seconds to wait before retrying.
schema:
  type: integer
  minimum: 1
  description: A positive delay in whole seconds.
  example: 2
```

##### `#/components/headers/NoStore`

```yaml
description: Prevents caching this response.
schema:
  type: string
  enum:
    - no-store
  description: Always the cache directive no-store.
  example: no-store
```

##### `#/components/parameters/VersionHeader`

```yaml
name: UDX-Version
in: header
required: false
description: Dated API version (YYYY-MM-DD).
schema:
  type: string
  minLength: 10
  maxLength: 10
  description: A dated API version (YYYY-MM-DD).
  example: 2026-07-15
```

##### `#/components/parameters/PaginationLimit`

```yaml
name: limit
in: query
required: false
description: Maximum number of items to return in one page.
schema:
  type: integer
  minimum: 1
  maximum: 100
  default: 10
  description: Page size.
  example: 10
```

##### `#/components/parameters/PaginationPage`

```yaml
name: page
in: query
required: false
description: Opaque token identifying the requested page.
schema:
  type: string
  maxLength: 512
  description: An opaque pagination cursor.
  example: eyJ2IjoxLCJzIjoiMjAyNi0wNi0wMVQxMjowMDowMC4wMDAwMDBaIiwiaWQiOiIzNTE3NDU2MjI5NjM0MTg1NjQ2In0
```

##### `#/components/parameters/AccountsSort`

```yaml
name: sort
in: query
required: false
description: Field to sort accounts by.
schema:
  type: string
  enum:
    - created_at
  default: created_at
  description: A sortable account field.
  example: created_at
```

##### `#/components/parameters/PaginationOrder`

```yaml
name: order
in: query
required: false
description: Sort direction. Applies to the default sort field when sort is omitted. Nulls sort last in both directions.
schema:
  type: string
  enum:
    - asc
    - desc
  default: desc
  description: Sort direction.
  example: desc
```