Skip to navigation

List your organisations

The organisations you hold an active seat in — every one that invited you, under your one identity-provider subject — as a page (limit, cursor, include=total), a set ascending by orgId. Read through the organisation your token names: a token that organisation refuses lists nothing. Drives an organisation switcher.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Request-IdstringOptional

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.

Query parameters

limitintegerOptional>=1

Page size, 1-100; larger values are clamped. Without it the whole collection is served as one page.

cursorstringOptional<=2048 characters

nextCursor or prevCursor from a previous page, sent with the same filters. One that does not decode, or that came from another query, is refused 400 INVALID_CURSOR: drop it and fetch the first page.

includeenumOptional

total adds the exact number of rows matching the filters.

Allowed values:

Response

A page of your organisations, ascending by orgId; the position it was read at rides the body and the headers.

asOfSeqTsNsstring or nullformat: "^[0-9]+$"

The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

itemslist of objects
nextCursorstring or null

Pass as cursor for the next page. Null on the last page.

prevCursorstring or null

Pass as cursor for the previous page. Null on the first page.

totalinteger or null

Exact count matching the filter. Null unless include=total.

Errors

400
Get MY Orgs Users Request Bad Request Error
401
Get MY Orgs Users Request Unauthorized Error
403
Get MY Orgs Users Request Forbidden Error
503
Get MY Orgs Users Request Service Unavailable Error