> 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.

# Get an approval rule

GET /approval-rules/{id}

Serves one of your organisation's approval rules by its id — its count and any lowering pending on it; `GET /approval-rules?family=` finds a family's. Its `ETag` is the `If-Match` the rule's writes take. No capability gates it: membership reads it.

Reference: https://docs.immix.xyz/trading/api-reference/rest-api/approval-rules/get

## Authentication

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

## Request

### Path parameters

- `id` (integer, required) — The record's id — a positive 32-bit integer the platform minted.

### Query parameters

- `view` (enum, optional, default: latest) — `latest` (the default) shows a row's pending proposal where one exists; `approved` shows what the platform enforces. Resources without proposals serve the same rows for both.
  - Allowed values: `latest`, `approved`
- `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

The approval rule's row, rendered as the guide's Reads section describes: the position header and body field, the `ETag`.

- `approvalRuleId` (integer, required) — Sticky entity key.
- `approvals` (list of ApprovalRuleUpdatedApprovalsItem, required) — Who approved the row's last proposal and when, in approval order — grown by each approval and kept on the concluded row as its record until the next proposal or a withdrawal clears it; empty until the first approval. The proposal concludes at the approval that meets the organisation's count for the family as it stands then; pendingTransition says whether one is pending. a repeating group served as an array of objects, in the group's own order; empty = no entries, never null
- `concludedTransition` (enum, required) — What the row's last proposal proposed, kept once it concluded: the pending transition the conclusion cleared, as the register wrote it; NONE while it pends, or where none was. So the concluded row says what concluded, however its status has moved on since. NONE is the unset sentinel: outputs only — as input the field is required, and explicit NONE refuses 400. A consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict
  - Allowed values: `NONE`, `ACTIVATE`, `AMEND`, `ENABLE`, `DELETE`, `ROTATE`, `RESUME_TRADING`, `KEY_CHANGE`
- `count` (integer, required) — Approvals a proposal in the family needs: 0 (the default) = the maker's own write concludes it, 1 = one other user's approval, up to 4 — account addresses included since v16, their verifications being the approvals. uint8: an integer 0..255
- `family` (enum, required) — The family the rule governs; one rule per organisation and family. UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict
  - Allowed values: `UNKNOWN`, `ACCOUNTS`, `ACCOUNT_ADDRESSES`, `ASSET_POLICIES`, `CHAIN_POLICIES`, `TRADING_POLICIES`, `RISK`, `TRANSFERS`, `NOTIFICATIONS`
- `globalSequence` (string, required) — The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.
- `lastWithdrawalReason` (string, required) — Why the last proposal was withdrawn, as the withdrawer stated it; empty-not-null, and empty when a raise or restatement replaced it.
- `orgId` (integer, required) — Owner-stamped.
- `pendingTransition` (enum, required) — AMEND while a lowering of the count waits for a second org:manage holder; NONE otherwise. NONE is the unset sentinel: outputs only — as input the field is required, and explicit NONE refuses 400. A consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict
  - Allowed values: `NONE`, `ACTIVATE`, `AMEND`, `ENABLE`, `DELETE`, `ROTATE`, `RESUME_TRADING`, `KEY_CHANGE`
- `remark` (string, required) — The maker's note on the pending proposal, for its approvers; empty-not-null. At most 256 bytes; longer refuses INVALID_FIELD.
- `version` (string, required) — Monotonic per entity. int64 as a decimal JSON string
- `concludedAtNs` (string, optional, nullable) — Platform time the row's last proposal concluded; 0 while it is pending, or when the row never carried one. A write the organisation's count let through at once concludes in the maker's own fact: equal to proposedAtNs. int64 as a decimal JSON string
- `concludedBy` (Actor, optional, nullable) — Who concluded the row's last proposal: the approver whose approval met the organisation's count, or the maker when the count was 0 and the write concluded at once; null while it is pending, or when the row never carried one. an actor: an object \{kind, id}; null where none is stated
- `keyHolder` (Actor, optional, nullable) — When an API key made the row's last proposal, the member the key's secret had last been answered to as it proposed — its last rotator then, else its issuer — kept on the concluded row with proposedBy; null when a member made the proposal, or the row never carried one. The proposal counts as this member's and the key's issuer's, whoever rotates the key afterwards: neither may approve it (SELF\_APPROVAL). an actor: an object \{kind, id}; null where none is stated
- `lastWithdrawalAtNs` (string, optional, nullable) — Platform time of that withdrawal; 0 when none was. The three fields and lastWithdrawalReason stand until the row's next write: a new lowering replaces them, and a raise or restatement made with nothing pending clears them with the rest of the record. int64 as a decimal JSON string
- `lastWithdrawalProposedBy` (Actor, optional, nullable) — Who made the last proposal that was withdrawn; null when none was. an actor: an object \{kind, id}; null where none is stated
- `lastWithdrawalWithdrawnBy` (Actor, optional, nullable) — Who withdrew it — the proposer, a holder returning it, or the holder whose raise or restatement replaced it; null when none was. an actor: an object \{kind, id}; null where none is stated
- `proposedAtNs` (string, optional, nullable) — Platform time the row's last proposal was made, kept on the concluded row; 0 when the row never carried one. int64 as a decimal JSON string
- `proposedBy` (Actor, optional, nullable) — Who made the row's last proposal — kept on the concluded row as its record; null when the row never carried one (a row a connector or the platform landed). pendingTransition says whether that proposal is still pending. an actor: an object \{kind, id}; null where none is stated

## Errors

### 400 Get Approval Rules 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 Get Approval Rules 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 Get Approval Rules 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.

### 404 Get Approval Rules Request Not Found Error

No such row in your organisation — another organisation's row is indistinguishable from an absent one. The position header says as of when.

- `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 Get Approval Rules 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

### ApprovalRuleUpdatedApprovalsItem

- `userId` (integer, required) — An approving user.
- `approvedAtNs` (string, optional, nullable) — Platform time of the approval. int64 as a decimal JSON string

### Actor

Who acted — the principal behind a command, a row's maker or its concluder: a member (USER, id = the user id), an API key the organisation issued (API_KEY, id = the API key id), or the platform itself (MACHINE, id 0 — a connector's report, an algo instance's order, the door's own write). The kind's value set is append-only: a consumer READING an unknown kind treats the actor as unknown, never as an error.

- `kind` (enum, required) — The kind of principal; which id space `id` names.
  - Allowed values: `USER`, `API_KEY`, `MACHINE`
- `id` (integer, required) — The principal's id in its kind's space: a user id, an API key id, or 0 for the platform itself.

### 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
{
  "approvalRuleId": 1,
  "approvals": [
    {
      "userId": 1,
      "approvedAtNs": "approvedAtNs"
    }
  ],
  "concludedTransition": "NONE",
  "count": 1,
  "family": "UNKNOWN",
  "globalSequence": "globalSequence",
  "lastWithdrawalReason": "lastWithdrawalReason",
  "orgId": 1,
  "pendingTransition": "NONE",
  "remark": "remark",
  "version": "version",
  "concludedAtNs": "concludedAtNs",
  "concludedBy": {
    "kind": "USER",
    "id": 1
  },
  "keyHolder": {
    "kind": "USER",
    "id": 1
  },
  "lastWithdrawalAtNs": "lastWithdrawalAtNs",
  "lastWithdrawalProposedBy": {
    "kind": "USER",
    "id": 1
  },
  "lastWithdrawalWithdrawnBy": {
    "kind": "USER",
    "id": 1
  },
  "proposedAtNs": "proposedAtNs",
  "proposedBy": {
    "kind": "USER",
    "id": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/approval-rules/1"

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

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

print(response.json())
```

```javascript
const url = 'https://api.example.com/approval-rules/1';
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/approval-rules/1"

	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/approval-rules/1")

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/approval-rules/1")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/approval-rules/1");
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/approval-rules/1")! 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()
```