Properties
| Name | Type | Description |
|---|---|---|
| nextCursor | stringnull | Pass as `cursor` for the next page. Null on the last page. |
| prevCursor | stringnull | Pass as `cursor` for the previous page. Null on the first page. |
| total | integernull | Exact count matching the filter. Null unless `include=total`. |
| globalSequence | object | |
| asOfSeqTsNs | stringnull | The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown. |
| items | array | |
| unscaled | boolean | Never present since 0.3.3: every money value on this API states its own scale on the wire, so no item is ever served raw — the coarse collection form of RowExtras.unscaled, retired with it. Kept, depr |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/immix/json-schema/immix-users-list-users-response-schema.json",
"title": "ListUsersResponse",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/immix-users-api-openapi.yml#/components/schemas/users_ListUsersResponse",
"type": "object",
"properties": {
"nextCursor": {
"type": [
"string",
"null"
],
"description": "Pass as `cursor` for the next page. Null on the last page."
},
"prevCursor": {
"type": [
"string",
"null"
],
"description": "Pass as `cursor` for the previous page. Null on the first page."
},
"total": {
"type": [
"integer",
"null"
],
"description": "Exact count matching the filter. Null unless `include=total`."
},
"globalSequence": {
"$ref": "#/$defs/GlobalSequenceValue"
},
"asOfSeqTsNs": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]+$",
"description": "The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown."
},
"items": {
"type": "array",
"items": {
"$ref": "#/$defs/UserUpdated"
}
},
"unscaled": {
"type": "boolean",
"description": "Never present since 0.3.3: every money value on this API states its own scale on the wire, so no item is ever served raw — the coarse collection form of RowExtras.unscaled, retired with it. Kept, deprecated, so a client generated from 0.3.2 still compiles.",
"deprecated": true
}
},
"required": [
"nextCursor",
"prevCursor",
"total",
"globalSequence",
"asOfSeqTsNs",
"items"
],
"$defs": {
"GlobalSequenceValue": {
"type": "string",
"pattern": "^[0-9]+$",
"description": "The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.",
"title": "GlobalSequenceValue"
},
"UserUpdated": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"description": "Sticky entity key."
},
"version": {
"type": "string",
"pattern": "^-?[0-9]+$",
"description": "Monotonic per entity. int64 as a decimal JSON string"
},
"orgId": {
"type": "integer",
"description": "Membership — stamped by the owner from the actor's org, or from the discovery's parent ref."
},
"status": {
"$ref": "#/$defs/UserUpdatedStatus",
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: 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"
},
"kind": {
"$ref": "#/$defs/UserUpdatedKind",
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: 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"
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/$defs/UserUpdatedCapabilitiesItem"
},
"description": "The user's capabilities — what they may do; empty on a discovered row, and on an invited first administrator until the organisation is activated. a set (SBE bit-set) served as the array of its scope strings — each choice spelled <route family>:<verb> (the schema's camel-cased choice name de-camelled: accountAddressesApprove is account-addresses:approve) — in declared order; empty = none set, never null. The choice set is append-only: a consumer READING this field skips an unknown name, never errors; as input an unknown or repeated name refuses 400 — the parse is strict"
},
"invitedByUserId": {
"type": [
"integer",
"null"
],
"description": "Who proposed or invited this user: the maker on an organisation's first administrator — stamped at the proposal, whether or not an email follows — and the inviter on an invited member; absent — null in the API, 0 on the wire — on a row created directly or discovered."
},
"inviteExpiresAtNs": {
"type": [
"string",
"null"
],
"pattern": "^-?[0-9]+$",
"description": "The deadline the row was last invited under: the inviting command's position time plus its stated lifetime; absent — null in the API, 0 on the wire — on a row never invited. Kept after the claim and after a cancel — status and invitationState say whether an invitation is open. A first login after it is refused INVITATION_EXPIRED and a re-invite opens a fresh deadline. int64 as a decimal JSON string"
},
"invitationState": {
"$ref": "#/$defs/UserUpdatedInvitationState",
"description": "Where the invitation stands: PENDING until the platform has created it with the identity provider, then SENT, ALREADY_MEMBER or FAILED; ACCEPTED once the invitee has signed in; NONE where none was created (a first administrator before activation). Kept after a cancel — an invitation is open while status is INVITED. NONE is the unset sentinel: outputs only — as input, omit the field instead; explicit NONE refuses 400. The value set is append-only: 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"
},
"name": {
"type": "string",
"description": "Platform name — per-org unique among live users with a non-empty name; empty until admission."
},
"idpUserRef": {
"type": "string",
"description": "The identity provider's subject, opaque, never parsed: a token's sub resolves to this row inside the token's organisation. Empty = unbound (a locally authenticated user). Unique among all the organisation's users, disabled included — a subject binds for the life of its row, and a second binding is refused IDP_REF_TAKEN."
},
"displayName": {
"type": "string",
"description": "What the IdP stated at discovery (the name, else email, else nickname claim); informational, never a key."
},
"email": {
"type": "string",
"description": "The address the user was invited at, lowercased — the address a first login must have verified to claim the row, kept afterwards as the address the user was registered by. Empty on a row no invitation created. Unique among the organisation's invited and active users (EMAIL_TAKEN)."
},
"idpInvitationRef": {
"type": "string",
"description": "The identity provider's id for the invitation the platform created, as the platform reported it; informational, never a key; empty until reported."
}
},
"required": [
"userId",
"version",
"orgId",
"status",
"kind",
"capabilities",
"name",
"displayName"
],
"title": "UserUpdated"
},
"UserUpdatedCapabilitiesItem": {
"type": "string",
"enum": [
"users:manage",
"credentials:propose",
"credentials:approve",
"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",
"orgs:propose",
"orgs:approve",
"algos:manage"
],
"title": "UserUpdatedCapabilitiesItem"
},
"UserUpdatedInvitationState": {
"type": "string",
"enum": [
"NONE",
"PENDING",
"SENT",
"ALREADY_MEMBER",
"FAILED",
"ACCEPTED"
],
"description": "Where the invitation stands: PENDING until the platform has created it with the identity provider, then SENT, ALREADY_MEMBER or FAILED; ACCEPTED once the invitee has signed in; NONE where none was created (a first administrator before activation). Kept after a cancel — an invitation is open while status is INVITED. NONE is the unset sentinel: outputs only — as input, omit the field instead; explicit NONE refuses 400. The value set is append-only: 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",
"title": "UserUpdatedInvitationState"
},
"UserUpdatedKind": {
"type": "string",
"enum": [
"UNKNOWN",
"HUMAN",
"SERVICE"
],
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: 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",
"title": "UserUpdatedKind"
},
"UserUpdatedStatus": {
"type": "string",
"enum": [
"UNKNOWN",
"DISCOVERED",
"ACTIVE",
"DISABLED",
"INVITED"
],
"description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: 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",
"title": "UserUpdatedStatus"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/immix-users-list-users-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.