> 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 notification endpoints

GET /notifications/endpoints

Lists the organisation's notification endpoints — where its notifications are sent, and what each is sent. `view=approved` shows what notifications are sent by; the default includes pending proposals. Deleted endpoints are hidden unless `include=deleted`. Ordered by `endpointId`, ascending. A member without the surface is 503 `NOTIFICATIONS_UNAVAILABLE`. Needs `notifications:manage`.

Reference: https://docs.immix.xyz/trading/api-reference/rest-api/notifications/list-endpoints

## Authentication

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

## Request

### 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`
- `endpointId` (integer, optional) — Only rows whose `endpointId` is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not a positive 32-bit integer) refuses 400 `MALFORMED_REQUEST`; a value naming no row yields an empty collection.
- `status` (enum, optional) — Only rows whose `status` is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not one of the values listed) refuses 400 `MALFORMED_REQUEST`; a value naming no row yields an empty collection.
  - Allowed values: `PENDING_APPROVAL`, `ACTIVE`, `DELETED`
- `format` (enum, optional) — Only rows whose `format` is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not one of the values listed) refuses 400 `MALFORMED_REQUEST`; a value naming no row yields an empty collection.
  - Allowed values: `SLACK`
- `pendingTransition` (enum, optional) — Only rows whose `pendingTransition` is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not one of the values listed) refuses 400 `MALFORMED_REQUEST`; a value naming no row yields an empty collection.
  - Allowed values: `NONE`, `ACTIVATE`, `AMEND`, `DELETE`
- `sort` (string, optional, default: endpointId) — Comma-separated `endpointId`, `status`, `format`, `pendingTransition`, `proposedAtNs`, `concludedAtNs`, `updatedAtNs` or `name`; prefix `-` for descending. Default `endpointId`.
- `limit` (integer, optional) — Page size, 1-100; larger values are clamped. Without it the whole collection is served as one page.
- `cursor` (string, optional) — `nextCursor` or `prevCursor` from a previous page, sent with the same filters and the same `sort`. One that does not decode, or that came from another query, is refused 400 `INVALID_CURSOR`: drop it and fetch the first page.
- `include` (enum, optional) — `total` adds the exact number of rows matching the filters — the set served. `deleted` (0.39.0) serves the deleted rows among the live ones: without it, and without a `status` filter, the list leaves out the rows its terminal state has reached; a by-id read serves them as ever. `deleted` binds into the cursor as a filter does; `total` never did.
  - Allowed values: `total`, `deleted`
- `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

A page of the rows inside the principal's org, in the operation's order, or the one `sort` asks — all of them unless `limit` is sent; the position it was read at rides the body and the headers.

- `asOfSeqTsNs` (string, required, nullable) — The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.
- `globalSequence` (string, required) — The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.
- `items` (list of NotificationEndpointUpdated, required)
- `nextCursor` (string, required, nullable) — Pass as `cursor` for the next page. Null on the last page.
- `prevCursor` (string, required, nullable) — Pass as `cursor` for the previous page. Null on the first page.
- `total` (integer, required, nullable) — Exact count matching the filter. Null unless `include=total`.

## Errors

### 400 List Endpoints Notifications 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 Endpoints Notifications 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 Endpoints Notifications 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 Endpoints Notifications Request Service Unavailable Error

This member cannot serve the notification endpoints now: `NOT_PRIMED` — it is still catching up; retry shortly — `PROJECTION_BEHIND` — behind your `minGlobalSequence`; retry after `Retry-After` — or `NOTIFICATIONS_UNAVAILABLE` — it is deployed without the surface, so a retry here changes nothing; every other route is unaffected. On a write also `NOT_SERVING`, `OWNER_ABSENT`, `INTAKE_UNAVAILABLE` (no secret store here, on a write that names a `url`), or the platform's own outcome for a command lost in transit — nothing journaled; retry against a serving member.

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

### NotificationEndpointUpdated

- `endpointId` (integer, required) — Sticky entity key.
- `version` (string, required) — The row's version - monotonic, bumped on every change. int64 as a decimal JSON string
- `orgId` (integer, required) — The organisation the endpoint belongs to.
- `status` (enum, required) — PENDING_APPROVAL until the endpoint's first proposal concludes - approved by another member, or made by the organisation's one member - then ACTIVE, the one status notifications are sent in, then DELETED. A first proposal that was withdrawn leaves the row PENDING_APPROVAL with nothing pending. 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`, `PENDING_APPROVAL`, `ACTIVE`, `DELETED`
- `format` (enum, required) — What the destination is sent: SLACK is a Slack message, posted to a Slack incoming-webhook URL. 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`, `SLACK`
- `minSeverity` (enum, required) — The least urgent event the endpoint is sent: INFO sends every event, WARNING leaves INFO out, CRITICAL sends CRITICAL alone. 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`, `INFO`, `WARNING`, `CRITICAL`
- `events` (list of enum, required) — The event types the endpoint is sent; never empty. a set (SBE bit-set) served as the array of its published names, each a `NotificationEvent`, in declared order; empty = none set, never null; as input a repeated name refuses 400
  - Allowed values: `algo.instance.state_changed`, `algo.halted`, `algo.instance.config_refused`, `algo.instance.config_applied`, `algo.instance.version_moved`
- `pendingTransition` (enum, required) — ACTIVATE or AMEND while a proposal waits for approval; NONE otherwise. While an AMEND waits, notifications are still sent as last approved. 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`, `DELETE`
- `concludedTransition` (enum, required) — What the row's last proposal proposed, kept once it concluded: ACTIVATE, AMEND or DELETE; NONE while it pends or when it was withdrawn. 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`, `DELETE`
- `updatedAtNs` (string, required) — Platform time of this version. int64 as a decimal JSON string
- `updatedBy` (Actor, required) — The member behind this version. an actor: an object \{kind, id}
- `algoInstances` (list of NotificationEndpointUpdatedAlgoInstancesItem, required) — The algo instances the endpoint is sent events about; empty = every instance of the organisation. It narrows the events that name an instance: one that names none - the organisation-wide halt - is sent whatever this list holds. a repeating group served as an array of objects, in the group's own order; empty = no entries, never null
- `approvals` (list of NotificationEndpointUpdatedApprovalsItem, required) — Who approved the row's last proposal and when, in order. A proposal that waits concludes when the count reaches the organisation's notifications approval rule, and never before one approval; the list is empty where the proposal concluded as it was made - its maker the organisation's one member, or a deletion. a repeating group served as an array of objects, in the group's own order; empty = no entries, never null
- `name` (string, required) — The endpoint's name, as its organisation lists it - 1 to 128 bytes of UTF-8.
- `urlFingerprint` (string, required) — The destination URL's fingerprint as the gateway computed it when the URL was stored - enough to tell two URLs apart, never enough to rebuild one: fp- and sixteen lowercase hexadecimal digits.
- `host` (string, required) — The destination's host name alone - no scheme, port or path - at most 253 characters of lowercase letters, digits, dot and hyphen.
- `remark` (string, required) — The maker's note on the last proposal, for its approvers; empty-not-null. At most 256 bytes of UTF-8.
- `lastWithdrawalReason` (string, required) — Why the last proposal was withdrawn, as the withdrawer stated it; empty-not-null.
- `proposedBy` (Actor, optional, nullable) — The maker of the row's last proposal, kept after it concludes or is withdrawn - an approver is checked to be someone else while it pends. pendingTransition alone says whether a proposal pends. an actor: an object \{kind, id}; null where none is stated
- `proposedAtNs` (string, optional, nullable) — Platform time the row's last proposal was made. int64 as a decimal JSON string
- `concludedAtNs` (string, optional, nullable) — Platform time the row's last proposal concluded - equal to proposedAtNs where it concluded as it was made; 0 while it pends or when it was withdrawn. int64 as a decimal JSON string
- `concludedBy` (Actor, optional, nullable) — Who concluded it - the approver whose approval met the count, or the maker where it concluded as it was made; unstated when concludedAtNs is 0. an actor: an object \{kind, id}; null where none is stated
- `lastWithdrawalProposedBy` (Actor, optional, nullable) — Who made the last proposal that was withdrawn; unstated when none was. an actor: an object \{kind, id}; null where none is stated
- `lastWithdrawalWithdrawnBy` (Actor, optional, nullable) — Who withdrew it - its maker, another member returning it, or the member whose deletion replaced it; unstated when none was. an actor: an object \{kind, id}; null where none is stated
- `lastWithdrawalAtNs` (string, optional, nullable) — Platform time of that withdrawal; 0 when none was. int64 as a decimal JSON string

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

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

### NotificationEndpointUpdatedAlgoInstancesItem

- `instanceId` (integer, required) — An algo instance.

### NotificationEndpointUpdatedApprovalsItem

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

## Examples

**Response**

```json
{
  "asOfSeqTsNs": "1791553927418203000",
  "globalSequence": "250113",
  "items": [
    {
      "endpointId": 118836922,
      "version": "2",
      "orgId": 69761052,
      "status": "ACTIVE",
      "format": "SLACK",
      "minSeverity": "WARNING",
      "events": [
        "algo.instance.state_changed",
        "algo.halted"
      ],
      "pendingTransition": "NONE",
      "concludedTransition": "ACTIVATE",
      "updatedAtNs": "1791370960000000000",
      "updatedBy": {
        "kind": "USER",
        "id": 69930775
      },
      "algoInstances": [
        {
          "instanceId": 1
        }
      ],
      "approvals": [
        {
          "userId": 69930775,
          "approvedAtNs": "1791370960000000000"
        }
      ],
      "name": "Desk alerts",
      "urlFingerprint": "fp-3f9a1c0b7e2d4a68",
      "host": "hooks.slack.com",
      "remark": "The desk channel",
      "lastWithdrawalReason": "",
      "proposedBy": {
        "kind": "USER",
        "id": 69761055
      },
      "proposedAtNs": "1791368122000000000",
      "concludedAtNs": "1791370960000000000",
      "concludedBy": {
        "kind": "USER",
        "id": 69930775
      }
    },
    {
      "endpointId": 119007667,
      "version": "1",
      "orgId": 69761052,
      "status": "PENDING_APPROVAL",
      "format": "SLACK",
      "minSeverity": "CRITICAL",
      "events": [
        "algo.instance.state_changed",
        "algo.halted",
        "algo.instance.config_refused"
      ],
      "pendingTransition": "ACTIVATE",
      "concludedTransition": "NONE",
      "updatedAtNs": "1791538867000000000",
      "updatedBy": {
        "kind": "USER",
        "id": 69930775
      },
      "algoInstances": [
        {
          "instanceId": 118401267
        }
      ],
      "approvals": [
        {
          "userId": 1,
          "approvedAtNs": "approvedAtNs"
        }
      ],
      "name": "BTC quoter halts",
      "urlFingerprint": "fp-b81d0e55c2a94f37",
      "host": "hooks.slack.com",
      "remark": "On-call only",
      "lastWithdrawalReason": "",
      "proposedBy": {
        "kind": "USER",
        "id": 69930775
      },
      "proposedAtNs": "1791538867000000000"
    }
  ],
  "total": 2
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/notifications/endpoints"

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

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

print(response.json())
```

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

	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/notifications/endpoints")

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

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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