mammoth-io Preferences API
The Preferences API from mammoth-io — 1 operation(s) for preferences.
The Preferences API from mammoth-io — 1 operation(s) for preferences.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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.curl "https://apis.io/api/v1/apis/mammoth-io:mammoth-io-preferences-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mammoth Io Preferences API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged Preferences across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
apiSecret: []
workspaceId: []
tags:
- name: Preferences
paths:
/preferences:
get:
tags:
- Preferences
summary: Fetch user preferences
description: This endpoint is used to fetch user preferences.
operationId: GetUserPreferences
responses:
'200':
description: Preferences data
content:
application/json:
schema:
$ref: '#/components/schemas/PreferencesSchema'
'400':
description: Bad Request
'401':
description: Authorization error
deprecated: false
patch:
tags:
- Preferences
summary: Update user preferences
description: This endpoint is used to update user preferences.
operationId: UpdateUserPreferences
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PreferencesPatchRequest'
required: true
responses:
'200':
description: Preferences updated
'400':
description: Bad Request
'401':
description: Authorization error
deprecated: false
servers:
- url: /api/v2
components:
schemas:
PreferencesPatchOp:
properties:
op:
$ref: '#/components/schemas/OpsValues'
path:
type: string
maxLength: 200
minLength: 1
description: Dot-separated preference path rooted at GLOBAL or WORKSPACE_PREFERENCES, e.g. GLOBAL.PREFERENCES.TOP_TABS_24
examples:
- value: GLOBAL.PREFERENCES.TOP_TABS
value:
oneOf:
- type: object
- type: array
- type: string
- type: boolean
- type: integer
- type: number
- type: 'null'
description: Preference value (object, list, scalar, or null)
type: object
required:
- op
- path
title: PreferencesPatchOp
SelfServeSchema:
properties:
onboarding_state:
type: string
minLength: 1
description: Onboarding State
examples:
- value: registered
type: object
required:
- onboarding_state
title: SelfServeSchema
OnboardingSchema:
properties:
DATAFLOW_SETTINGS:
type: boolean
description: Dataflow Settings
default: false
examples:
- value: true
type: object
required: []
title: OnboardingSchema
PreferencesPatchRequest:
properties:
patch:
items:
$ref: '#/components/schemas/PreferencesPatchOp'
type: array
type: object
required:
- patch
title: PreferencesPatchRequest
description: Preferences Patch Request
examples:
- patch:
- op: replace
path: global.self_serve
value:
onboarding_state: registered
- patch:
- op: replace
path: global.onboarding
value:
DATAFLOW_SETTINGS: false
- patch:
- op: replace
path: global
value:
SELF_SERVE:
onboarding_state: registered
ONBOARDING:
DATAFLOW_SETTINGS: true
- patch:
- op: replace
path: GLOBAL.PREFERENCES.TOP_TABS_24
value:
- type: dataset
id: 2555
order: 0
- patch:
- op: replace
path: GLOBAL.PREFERENCES.PIPELINE_DISPLAY_NOTES
value: true
DashboardsSchema:
properties:
pinned_ids:
items:
type: string
type: array
type: object
required: []
title: DashboardsSchema
WorkflowsSchema:
properties:
pinned_ids:
items:
type: string
type: array
groups:
items:
type: object
type: array
group_map:
additionalProperties:
type: string
type: object
type: object
required: []
title: WorkflowsSchema
OpsValues:
type: string
enum:
- replace
maxLength: 50
minLength: 1
title: OpsValues
description: Operation
examples:
- value: replace
GlobalSchema:
properties:
SELF_SERVE:
oneOf:
- $ref: '#/components/schemas/SelfServeSchema'
- type: 'null'
description: Self Serve
examples:
- value:
onboarding_state: registered
ONBOARDING:
oneOf:
- $ref: '#/components/schemas/OnboardingSchema'
- type: 'null'
description: Onboarding
examples:
- value:
DATAFLOW_SETTINGS: true
WORKFLOWS:
oneOf:
- $ref: '#/components/schemas/WorkflowsSchema'
- type: 'null'
DASHBOARDS:
oneOf:
- $ref: '#/components/schemas/DashboardsSchema'
- type: 'null'
FIRST_TIME_ON_DL:
oneOf:
- type: boolean
- type: 'null'
description: First Time On Data Landing
examples:
- value: true
PREFERENCES:
oneOf:
- type: object
- type: 'null'
description: Data landing preferences (dataset/view scoped keys)
examples:
- value:
TOP_TABS_11:
- id: 8
type: object
required: []
title: GlobalSchema
PreferencesSchema:
properties:
GLOBAL:
$ref: '#/components/schemas/GlobalSchema'
type: object
required:
- GLOBAL
title: PreferencesSchema
securitySchemes:
bearerAuth:
type: http
description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
scheme: bearer
apiKey:
type: apiKey
description: Deprecated — use bearerAuth.
name: X-API-KEY
in: header
apiSecret:
type: apiKey
description: Deprecated — use bearerAuth.
name: X-API-SECRET
in: header
workspaceId:
type: apiKey
description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
name: X-WORKSPACE-ID
in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json