> This page is for Trading.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.immix.xyz/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.immix.xyz/_mcp/server.

# List capability presets

GET /capability-presets

Lists the capability presets a user or invitation body's `preset` names — each one's name, its capabilities as scope strings, and what it grants — for a picker to fill a member's capabilities from. Served to every admitted member as one document, never a page: a preset is a starting point, not a record, and no row names the one a member was given.

Reference: https://docs.immix.xyz/trading/api-reference/rest-api/users/list-capability-presets

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `minGlobalSequence` (string, optional) — A position you hold — an `X-Immix-Global-Sequence` you read, or a 202's `commandGlobalSequence`: this member answers only once it has folded the platform's stream through it, waiting up to its deadline, then 503 `PROJECTION_BEHIND` with `Retry-After`. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202's position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 `MALFORMED_REQUEST`.

### Headers

- `X-Request-Id` (string, optional) — Your own id for the request: 8 to 128 of `[A-Za-z0-9._-]`. It becomes the request's id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

## Response

### 200

Every preset, in the order a picker lists them. The position it was served at rides the two position headers, as on every read; the document does not move with it.

- `presets` (list of CapabilityPreset, required) — Every preset, in the order a picker lists them.

## Errors

### 400 List Capability Presets Users Request Bad Request Error

The request's shape is wrong: a non-positive id, an unknown `view` or filter value, a query string that does not decode, a query parameter the operation does not take, or a cursor that does not decode or came from another query (`INVALID_CURSOR`). No position rides a refusal that consulted no state.

- `error` (ErrorBody, required) — What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 401 List Capability Presets Users Request Unauthorized Error

No bearer token, or one that does not verify.

- `error` (ErrorBody, required) — What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 403 List Capability Presets Users Request Forbidden Error

`CAPABILITY_DENIED`: a read your capabilities do not cover, or a staging route without its propose bit (`accounts:propose`). `NOT_REGISTERED`: no row or open invitation at your verified address, an unknown organisation, or an unclaimed row (an administrator admits it). `EMAIL_UNVERIFIED`: verify, then sign in again. `INVITATION_EXPIRED`: an administrator re-invites. `FORBIDDEN_PRINCIPAL`: no `org_id`, a non-ASCII ref, a disabled user, a binding with no user. `ORG_NOT_ACTIVE`: disabled, pending or deleted. Owners' 403s carry the position header and `Idempotent-Replay`.

- `error` (ErrorBody, required) — What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

### 503 List Capability Presets Users Request Service Unavailable Error

This member is still catching up (`NOT_PRIMED`; retry shortly), or had not folded through the `minGlobalSequence` you sent by the deadline (`PROJECTION_BEHIND`; retry after `Retry-After`).

- `error` (ErrorBody, required) — What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.
- `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry.

## Types

### CapabilityPreset

One preset: the name a body's `preset` takes, the capabilities it expands to, and what it grants. A member whose `capabilities` equal a preset's exactly may be shown with the preset's name; any other set is the member's own.

- `preset` (enum, required) — The preset's name — the value a user or invitation body's `preset` takes.
  - Allowed values: `INITIATOR`, `APPROVER`, `ADMIN`, `TRADER`, `TREASURY`
- `capabilities` (list of enum, required) — The capabilities the preset expands to, as scope strings in the order a user row lists its own. The set of scopes only grows: a reader skips a name it does not know.
  - Allowed values: `users:manage`, `accounts:propose`, `accounts:approve`, `account-addresses:propose`, `account-addresses:approve`, `portfolios:manage`, `asset-policies:propose`, `asset-policies:approve`, `chain-policies:propose`, `chain-policies:approve`, `trading-policies:propose`, `trading-policies:approve`, `orders:trade`, `algos:manage`, `users:read`, `venue-keys:read`, `accounts:read`, `account-addresses:read`, `portfolios:read`, `asset-policies:read`, `chain-policies:read`, `trading-policies:read`, `orders:read`, `algos:read`, `org:manage`, `risk:read`, `risk:propose`, `risk:approve`, `api-keys:manage`, `transfers:read`, `transfers:propose`, `transfers:approve`, `notifications:manage`
- `description` (string, required) — What a member given the preset may do, in one sentence.

### ErrorBody

What a refusal states. Since `0.12.0` every refusal carries all four members; a member below it sends `code`, sometimes `message`, and neither of the others.

- `code` (string, required) — The code to branch on — stable and open (before 1.0.0 a minor may remove one, its changelog naming it): treat one you do not know by its HTTP status. The gateway's: - 400: `MALFORMED_REQUEST`, `MISSING_IDEMPOTENCY_KEY`, `INVALID_IDEMPOTENCY_KEY`, `INVALID_IF_MATCH`, `INVALID_CURSOR` - 401: `UNAUTHENTICATED` - 403: `FORBIDDEN_PRINCIPAL`, `NOT_REGISTERED`, `INVITATION_EXPIRED`, `EMAIL_UNVERIFIED`, `ORG_NOT_ACTIVE`, `CAPABILITY_DENIED` - 404: `NOT_FOUND`, `UNKNOWN_OPERATION`, `ROUTE_NOT_FOUND` (no route answers the path) - 405: `METHOD_NOT_ALLOWED` - 409: `IDEMPOTENCY_KEY_REUSED`, `INTAKE_KEY_REUSED`, `KEY_ALREADY_REGISTERED`, `CONNECTION_DOWN` (`POST /transfers`), `EXCEEDS_MARGIN_HEADROOM`, `HEADROOM_UNKNOWN` (a transfer's submit and its approval) - 413: `TOO_LARGE`, `PAYLOAD_TOO_LARGE`, `DOCUMENT_TOO_LARGE` - 422: a reference this member will not send: `INSTRUMENT_NOT_LIVE`, `ACCOUNT_NOT_ACTIVE` (`POST /orders`), `REFERENCE_UNKNOWN_INSTRUMENT`, `REFERENCE_INSTRUMENT_NOT_LIVE`, `REFERENCE_UNKNOWN_ACCOUNT` (an algo document); `VENUE_UNSUPPORTED`, `DEDICATED_KEY`, `DESTINATION_NOT_ALLOWED` - 428: `PRECONDITION_REQUIRED` - 429: `INBOX_FULL`, `IN_FLIGHT_FULL`, `RATE_LIMITED` - 500: `INTERRUPTED`, `INTERNAL_ERROR`, `PROJECTION_MISS` - 503: `NOT_PRIMED`, `NOT_SERVING`, `OWNER_ABSENT`, `INTAKE_UNAVAILABLE`, `BALANCES_UNAVAILABLE`, `POSITIONS_UNAVAILABLE`, `RISK_UNAVAILABLE`, `TRANSFERS_UNAVAILABLE`, `ALGOS_UNAVAILABLE`, `NOTIFICATIONS_UNAVAILABLE`, `TICKETS_UNAVAILABLE`, `REGISTRATION_PENDING`, `PROJECTION_BEHIND`, `LOST`, `REJECTED_NOT_REGISTERED`, `REJECTED_NOT_ACTIVE` The record owners' refusals ride verbatim — `OrgRegisterRejected.reason`, `OrderRejected.reason`, `AlgoRejected.reason`, `RiskLimitRejectReason`, `RiskAdjustmentRejectReason`, `ManualExecutionRejectReason`, `TransferRejectReason` and `NotificationEndpointRejected.reason` list them; the guide maps each to its status.
- `message` (string, required) — For display only; its wording may change at any time.
- `requestId` (string, required) — The request's id, also sent as X-Request-Id; quote it to support.
- `retryable` (boolean, required) — Whether sending the identical request again, its `Idempotency-Key` included, after `Retry-After` or a short pause, can succeed with nothing else changed. `false` where something must change first: the request, its key, its precondition, the caller's standing, or the platform's own records or deployment. A refusal the record owner judged is always `false`: it is the recorded answer to its key, which replays it.

## Examples

**Response**

```json
{
  "presets": [
    {
      "preset": "INITIATOR",
      "capabilities": [
        "accounts:propose",
        "account-addresses:propose",
        "asset-policies:propose",
        "chain-policies:propose",
        "trading-policies:propose",
        "venue-keys:read",
        "accounts:read",
        "account-addresses:read",
        "asset-policies:read",
        "chain-policies:read",
        "trading-policies:read",
        "risk:read",
        "risk:propose",
        "transfers:read",
        "transfers:propose"
      ],
      "description": "Proposes changes in seven of the maker-checker families (accounts and their venue keys, account addresses, the asset, chain and trading policies, risk, and transfers) and reads them, the venue keys included; it approves nothing."
    },
    {
      "preset": "APPROVER",
      "capabilities": [
        "accounts:propose",
        "accounts:approve",
        "account-addresses:propose",
        "account-addresses:approve",
        "asset-policies:propose",
        "asset-policies:approve",
        "chain-policies:propose",
        "chain-policies:approve",
        "trading-policies:propose",
        "trading-policies:approve",
        "venue-keys:read",
        "accounts:read",
        "account-addresses:read",
        "asset-policies:read",
        "chain-policies:read",
        "trading-policies:read",
        "risk:read",
        "risk:propose",
        "risk:approve",
        "transfers:read",
        "transfers:propose",
        "transfers:approve"
      ],
      "description": "Initiator plus approving proposals in the same seven families."
    },
    {
      "preset": "ADMIN",
      "capabilities": [
        "users:manage",
        "accounts:propose",
        "accounts:approve",
        "account-addresses:propose",
        "account-addresses:approve",
        "portfolios:manage",
        "asset-policies:propose",
        "asset-policies:approve",
        "chain-policies:propose",
        "chain-policies:approve",
        "trading-policies:propose",
        "trading-policies:approve",
        "users:read",
        "venue-keys:read",
        "accounts:read",
        "account-addresses:read",
        "portfolios:read",
        "asset-policies:read",
        "chain-policies:read",
        "trading-policies:read",
        "orders:read",
        "algos:read",
        "org:manage",
        "risk:read",
        "risk:propose",
        "risk:approve",
        "api-keys:manage",
        "transfers:read",
        "transfers:propose",
        "transfers:approve",
        "notifications:manage"
      ],
      "description": "Approver plus the organisation's members, API keys, portfolios, notification endpoints and own settings (users:manage, api-keys:manage, portfolios:manage, notifications:manage, org:manage) and every read; it holds neither orders:trade nor algos:manage, though users:manage grants any capability, its holder's own included."
    },
    {
      "preset": "TRADER",
      "capabilities": [
        "orders:trade",
        "accounts:read",
        "orders:read",
        "risk:read",
        "transfers:read"
      ],
      "description": "Places and cancels orders (orders:trade) and reads the orders, every account with its balances (accounts:read), since a ticket names an account, the accounts' risk (risk:read) and the transfers that move their capital (transfers:read)."
    },
    {
      "preset": "TREASURY",
      "capabilities": [
        "accounts:propose",
        "accounts:approve",
        "account-addresses:propose",
        "account-addresses:approve",
        "portfolios:manage",
        "asset-policies:propose",
        "asset-policies:approve",
        "chain-policies:propose",
        "chain-policies:approve",
        "accounts:read",
        "account-addresses:read",
        "portfolios:read",
        "asset-policies:read",
        "chain-policies:read",
        "risk:read"
      ],
      "description": "Governs where value moves: proposes and approves accounts and the changes to their venue keys (a key change is the account's proposal), account addresses and the asset and chain policies, manages portfolios and reads those families and the accounts' risk; it holds no trading policy or member bit and reads no venue key's record."
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/capability-presets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/capability-presets';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/capability-presets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/capability-presets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/capability-presets")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/capability-presets', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/capability-presets");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/capability-presets")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```