Connections App Data API

The App Data API from Connections — 11 operation(s) for app data.

GitHub OpenAPI

Operations 19

GET /v1/app-data/{appId} Data locker read - this app's per-user document: {settings, server_settings… #
POST /v1/app-data/{appId} Data locker write - body { settings, baseVersion, merge? }. #
DELETE /v1/app-data/{appId} Data locker forget - delete this app's row AND its version history for the user… #
GET /v1/app-data First-party list of the signed-in user's synced apps ({apps:[{app_id… #
GET /v1/app-data/{appId}/versions Data locker history - the last replaced versions of this app's document for the… #
POST /v1/app-data/{appId}/restore Data locker rollback - body { version } restores a document from /versions as a… #
POST /v1/app-data/{appId}/restore-deleted Data locker undelete - puts the document (and its history) a DELETE sent to… #
DELETE /v1/app-data/{appId}/purge Data locker purge - forgets the document, its history and its Trash copy for… #
GET /v1/app-data/{appId}/server Owner read of one user's full locker document incl. private_settings (?sub=). #
POST /v1/app-data/{appId}/server Owner write of the server tiers for one user - body { sub, server_settings?… #
DELETE /v1/app-data/{appId}/server Owner eviction - delete one user's locker document AND its version history… #
GET /v1/app-data/{appId}/pool The owner's Data Locker pool as this app sees it: {period, tier, pool_bytes… #
POST /v1/app-data/{appId}/pool Set this app's per-user size - body { per_user_bytes } (65536, 131072 or… #
GET /v1/app-data/{appId}/schema The app's registered locker validation schema, or null #
POST /v1/app-data/{appId}/schema Register/replace the locker validation schema (subset JSON Schema: top-level… #
GET /v1/app-data/{appId}/connector The app's private connector switch: {app_id, enabled, slug, status, suspended}. #
POST /v1/app-data/{appId}/connector Switch the app's private connector on or off - body { enabled }. #
GET /v1/app-data/{appId}/connector-spec The OpenAPI link this app's connector reads: {app_id, openapi_url, server… #
PUT /v1/app-data/{appId}/connector-spec Point the app's connector at its OpenAPI document - body { openapi_url }. #

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/connections-icu:connections-icu-app-data-api"
All apis
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.

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.

OpenAPI Specification

connections-icu-app-data-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Connections Icu App Data API
  version: 1.0.0
  description: 'Operations tagged App Data across 2 of this provider''s published API definitions: connections-icu-studio-openapi-original.json, connections-icu-studio-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://studio.connectionsapi.com
tags:
- name: App Data
paths:
  /v1/app-data/{appId}:
    get:
      summary: 'Data locker read - this app''s per-user document: {settings, server_settings…'
      security:
      - oauthUserToken: []
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: getV1AppDataByAppId
      x-operation-id-source: derived
    post:
      summary: Data locker write - body { settings, baseVersion, merge? }.
      security:
      - oauthUserToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - settings
              properties:
                settings:
                  type: object
                  description: REQUIRED. The user-writable tier of this app's settings document.
                merge:
                  type: boolean
                  description: true applies RFC 7386 JSON Merge Patch semantics - a DEEP merge where null deletes a key and nested objects merge, unlike a shallow PATCH. false (default) replaces the document.
                baseVersion:
                  type: integer
                  description: 'Optimistic concurrency: the version you read (0 on first write). A mismatch 409s with the current document rather than overwriting a concurrent write.'
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: postV1AppDataByAppId
      x-operation-id-source: derived
    delete:
      summary: Data locker forget - delete this app's row AND its version history for the user…
      security:
      - oauthUserToken: []
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: deleteV1AppDataByAppId
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data:
    get:
      summary: First-party list of the signed-in user's synced apps ({apps:[{app_id…
      security:
      - aegisBearer: []
      tags:
      - App Data
      operationId: getV1AppData
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/versions:
    get:
      summary: Data locker history - the last replaced versions of this app's document for the…
      security:
      - oauthUserToken: []
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: getV1AppDataByAppIdVersions
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/restore:
    post:
      summary: Data locker rollback - body { version } restores a document from /versions as a…
      security:
      - oauthUserToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - version
              properties:
                version:
                  type: integer
                  description: REQUIRED. The historical version to restore, from the version-history read.
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: postV1AppDataByAppIdRestore
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/restore-deleted:
    post:
      summary: Data locker undelete - puts the document (and its history) a DELETE sent to…
      security:
      - oauthUserToken: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties: {}
              description: No fields. The path appId and your session are the entire input.
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: postV1AppDataByAppIdRestoreDeleted
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/purge:
    delete:
      summary: Data locker purge - forgets the document, its history and its Trash copy for…
      security:
      - oauthUserToken: []
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: deleteV1AppDataByAppIdPurge
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/server:
    get:
      summary: Owner read of one user's full locker document incl. private_settings (?sub=).
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      - name: sub
        in: query
        required: true
        schema:
          type: string
        description: The target user's AEGIS sub.
      security:
      - aegisBearer: []
      - apiKey: []
      tags:
      - App Data
      operationId: getV1AppDataByAppIdServer
      x-operation-id-source: derived
    post:
      summary: Owner write of the server tiers for one user - body { sub, server_settings?…
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - sub
              description: 'The app-BACKEND path: write another user''s server tiers. Send at least one of server_settings / private_settings.'
              properties:
                sub:
                  type: string
                  description: REQUIRED. The AEGIS sub whose document you are writing.
                server_settings:
                  type: object
                  description: App-backend writable, user READABLE.
                private_settings:
                  type: object
                  description: App-backend only - never returned to the user.
                merge:
                  type: boolean
                  description: Deep-merge instead of replacing, same semantics as the user-tier write.
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: postV1AppDataByAppIdServer
      x-operation-id-source: derived
    delete:
      summary: Owner eviction - delete one user's locker document AND its version history…
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      - name: sub
        in: query
        required: true
        schema:
          type: string
        description: The target user's AEGIS sub.
      security:
      - aegisBearer: []
      - apiKey: []
      tags:
      - App Data
      operationId: deleteV1AppDataByAppIdServer
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/pool:
    get:
      summary: 'The owner''s Data Locker pool as this app sees it: {period, tier, pool_bytes…'
      security:
      - aegisBearer: []
      - apiKey: []
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: getV1AppDataByAppIdPool
      x-operation-id-source: derived
    post:
      summary: Set this app's per-user size - body { per_user_bytes } (65536, 131072 or…
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - per_user_bytes
              properties:
                per_user_bytes:
                  type: integer
                  enum:
                  - 65536
                  - 131072
                  - 262144
                  description: 'REQUIRED. This app''s per-user document size: 64, 128 or 256 KB. A bigger size uses the owner''s pool faster.'
                  x-setting:
                    id: studio.app_data_per_user_bytes
                    label: Data Locker size per user
                    synonyms:
                    - locker size
                    - per user storage
                    - app data size
                    - 64 128 256 kb
                    scope: oauth_app
                    group: 'Developer console: App Data Locker'
                    scopeParam: appId
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: postV1AppDataByAppIdPool
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/schema:
    get:
      summary: The app's registered locker validation schema, or null
      security:
      - aegisBearer: []
      - apiKey: []
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: getV1AppDataByAppIdSchema
      x-operation-id-source: derived
    post:
      summary: 'Register/replace the locker validation schema (subset JSON Schema: top-level…'
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - schema
              properties:
                schema:
                  type: object
                  description: 'REQUIRED. The schema document validating this app''s settings, MERGED over the stored one: a key sent replaces it, `properties` merges property by property (a property sent replaces that property whole), and null removes a key or a property. Send `schema: null` to DELETE the whole schema.'
                  properties:
                    properties:
                      type: object
                      additionalProperties:
                        type:
                        - object
                        - 'null'
                      description: 'The app''s settings, by key. `"x-ai-writable": true` on one lets a member''s own AI change it; send just the properties that change (each whole), null to remove one.'
                      x-setting:
                        id: studio.app_ai_writable_settings
                        label: Settings an app's AI may change
                        synonyms:
                        - ai writable settings
                        - let ai change settings
                        - app ai access
                        - x-ai-writable
                        scope: oauth_app
                        group: 'Developer console: App Data Locker'
                        scopeParam: appId
                    required:
                      type: array
                      items:
                        type: string
                      description: Keys a member's settings must carry. null removes the list.
                    additionalProperties:
                      type:
                      - boolean
                      - 'null'
                      description: Allow keys the schema does not name. null removes it.
                  x-merge: true
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: postV1AppDataByAppIdSchema
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/connector:
    get:
      summary: 'The app''s private connector switch: {app_id, enabled, slug, status, suspended}.'
      security:
      - aegisBearer: []
      - apiKey: []
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: getV1AppDataByAppIdConnector
      x-operation-id-source: derived
    post:
      summary: Switch the app's private connector on or off - body { enabled }.
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - enabled
              properties:
                enabled:
                  type: boolean
                  description: 'REQUIRED. true switches this app''s private connector on (members'' own AIs may then read their settings and change the ones the schema flags "x-ai-writable": true); false switches it off.'
                  x-setting:
                    id: studio.app_connector_enabled
                    label: App private connector
                    synonyms:
                    - members ai access
                    - app connector on off
                    - let member ai read settings
                    scope: oauth_app
                    group: 'Developer console: App Data Locker'
                    scopeParam: appId
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: postV1AppDataByAppIdConnector
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/app-data/{appId}/connector-spec:
    get:
      summary: 'The OpenAPI link this app''s connector reads: {app_id, openapi_url, server…'
      security:
      - aegisBearer: []
      - apiKey: []
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: getV1AppDataByAppIdConnectorSpec
      x-operation-id-source: derived
    put:
      summary: Point the app's connector at its OpenAPI document - body { openapi_url }.
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - openapi_url
              properties:
                openapi_url:
                  type: string
                  description: https URL of the app's OpenAPI 3 document.
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - App Data
      operationId: putV1AppDataByAppIdConnectorSpec
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
components:
  securitySchemes:
    aegisBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: The AEGIS SSO access token (Cognito JWT from the shared sign-in) presented as a Bearer on every /v1 call.
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: cnx_live_* | cnx_pub_*
      description: 'A key minted in the console, sent as a bearer token. `cnx_live_` carries cross-plane data scopes AND (when granted) Studio management scopes (apps:*, keys:*, projects:*, webhooks:*) that authorize the console-management operations below. `cnx_pub_` is the publishable, browser-safe tier (Stripe''s pk_ model): mint-time capped to :read scopes, requires a non-empty allowed-origins allowlist, refused on any non-GET/HEAD route, and rate-limited - safe to embed in client-side code.'
    oauthUserToken:
      type: http
      scheme: bearer
      description: EITHER (a) a Sign-in-with-Connections USER access token issued by accounts.connectionsapi.com to a registered OAuth app - the app acts on behalf of its signed-in user, rows are keyed by the token's own sub + client_id; OR (b) an app-bound publishable key (cnx_pub_, minted with an appId) presented on X-Connections-Api-Key ALONGSIDE the signed-in user's own plain AEGIS bearer on Authorization - the server derives (app_id, sub) from the two verified credentials. The publishable key alone authorizes nothing; both credentials are required. This second form is for a developer who wants the locker without standing up a full OAuth client - mint one publishable key bound to a registered app instead.
x-refined-from:
- connections-icu-studio-openapi-original.json
- connections-icu-studio-openapi.yml