Connections Preferences API

The Preferences API from Connections — 2 operation(s) for preferences.

GitHub OpenAPI

Operations 4

GET /v1/preferences Read the caller's preferences #
POST /v1/preferences Change some of the caller's preferences #
GET /preferences Read the caller's preferences #
POST /preferences Change some of the caller's preferences #

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-preferences-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-preferences-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Connections Icu Preferences API
  version: '1.0'
  description: 'Operations tagged Preferences across 8 of this provider''s published API definitions: connections-icu-analytics-openapi-original.json, connections-icu-events-openapi-original.json, connections-icu-product-openapi-original.json, connections-icu-studio-openapi-original.json, connections-icu-analytics-openapi.yml, connections-icu-events-openapi.yml, connections-icu-product-openapi.yml, connections-icu-studio-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://analytics.connectionsapi.com
- url: https://events.connectionsapi.com
- url: https://api.connectionsapi.com/v1
- url: https://studio.connectionsapi.com
tags:
- name: Preferences
paths:
  /v1/preferences:
    get:
      summary: Read the caller's preferences
      description: 'Every preference this app keeps for the signed-in member: the saved value, else the default.'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: '{ preferences: { <key>: value }, saved: string[] } - every key, stored values over defaults.'
        '401':
          description: Not signed in (no member session or Connections key).
        '403':
          description: The key lacks this plane's scope.
      tags:
      - Preferences
      operationId: getV1Preferences
      x-operation-id-source: derived
    post:
      summary: Change some of the caller's preferences
      description: Send any subset of the keys; only those change and every other preference stays as saved. null resets a key.
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                theme:
                  type: string
                  enum:
                  - light
                  - dark
                  - system
                  nullable: true
                  default: system
                  description: 'How Analytics looks: light, dark, or following the device''s system setting. Send null to reset it to the default.'
                  x-setting:
                    id: analytics.theme
                    label: Theme
                    synonyms:
                    - dark mode
                    - light mode
                    - appearance
                    - color scheme
                    scope: account
                    group: Appearance
                    description: 'How Analytics looks: light, dark, or following the device''s system setting'
      responses:
        '200':
          description: '{ preferences: { <key>: value }, saved: string[] } - every key, stored values over defaults.'
        '400':
          description: '{ error: invalid_body | no_preferences | unknown_preference | invalid_preference, key? }'
        '401':
          description: Not signed in (no member session or Connections key).
        '403':
          description: The key lacks this plane's scope.
      tags:
      - Preferences
      operationId: postV1Preferences
      x-operation-id-source: derived
    servers:
    - url: https://analytics.connectionsapi.com
  /preferences:
    get:
      summary: Read the caller's preferences
      description: 'Every preference this app keeps for the signed-in member: the saved value, else the default.'
      security:
      - ApiKey:
        - contacts:read
      - OAuth2:
        - contacts:read
      - memberSession: []
      responses:
        '200':
          description: '{ preferences: { <key>: value }, saved: string[] } - every key, stored values over defaults.'
        '401':
          description: Not signed in (no member session or Connections key).
        '403':
          description: The key lacks this plane's scope.
      tags:
      - Preferences
      operationId: getPreferences
      x-operation-id-source: derived
    post:
      summary: Change some of the caller's preferences
      description: Send any subset of the keys; only those change and every other preference stays as saved. null resets a key.
      security:
      - ApiKey:
        - contacts:write
      - OAuth2:
        - contacts:write
      - memberSession: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                capture_contact_location:
                  type:
                  - boolean
                  - 'null'
                  default: true
                  description: Whether a contact you add records the place you were when you added it. Send null to reset it to the default.
                  x-setting:
                    id: connections.capture_contact_location
                    label: Save where I meet people
                    synonyms:
                    - capture contact location
                    - location on new contacts
                    - where we met
                    scope: account
                    group: Privacy
                    description: Whether a contact you add records the place you were when you added it
                show_enrichment_history:
                  type:
                  - boolean
                  - 'null'
                  default: false
                  description: Whether a contact shows the history of what enrichment added or changed. Send null to reset it to the default.
                  x-setting:
                    id: connections.show_enrichment_history
                    label: Show enrichment history
                    synonyms:
                    - enrichment history
                    - enrichment log
                    - contact enrichment changes
                    scope: account
                    group: Privacy
                    description: Whether a contact shows the history of what enrichment added or changed
                show_star_ratings:
                  type:
                  - boolean
                  - 'null'
                  default: true
                  description: Whether contacts show the star rating you gave them. Send null to reset it to the default.
                  x-setting:
                    id: connections.show_star_ratings
                    label: Show star ratings
                    synonyms:
                    - star ratings
                    - contact ratings
                    - rating stars
                    scope: account
                    group: Privacy
                    description: Whether contacts show the star rating you gave them
                contact_display_density:
                  type:
                  - string
                  - 'null'
                  enum:
                  - comfortable
                  - dense
                  - compact
                  - null
                  default: compact
                  description: 'How tightly the contact list is laid out: comfortable, dense or compact. Send null to reset it to the default.'
                  x-setting:
                    id: connections.contact_display_density
                    label: Contact list density
                    synonyms:
                    - display density
                    - compact contacts
                    - comfortable rows
                    - row spacing
                    scope: account
                    group: Contacts
                    description: 'How tightly the contact list is laid out: comfortable, dense or compact'
                contact_image_size_percent:
                  type:
                  - integer
                  - 'null'
                  minimum: 100
                  maximum: 200
                  default: 100
                  description: How large contact photos are in the contact list, as a percent of the usual size (100 to 200). Send null to reset it to the default.
                  x-setting:
                    id: connections.contact_image_size_percent
                    label: Contact photo size
                    synonyms:
                    - image size
                    - avatar size
                    - photo size
                    - picture size
                    scope: account
                    group: Contacts
                    description: How large contact photos are in the contact list, as a percent of the usual size (100 to 200)
                theme:
                  type:
                  - string
                  - 'null'
                  enum:
                  - light
                  - dark
                  - system
                  - null
                  default: system
                  description: Whether Connections shows light, dark, or follows the device setting. Send null to reset it to the default.
                  x-setting:
                    id: connections.theme
                    label: Theme
                    synonyms:
                    - dark mode
                    - light mode
                    - appearance
                    - color scheme
                    scope: account
                    group: Appearance
                    description: Whether Connections shows light, dark, or follows the device setting
      responses:
        '200':
          description: '{ preferences: { <key>: value }, saved: string[] } - every key, stored values over defaults.'
        '400':
          description: '{ error: invalid_body | no_preferences | unknown_preference | invalid_preference, key? }'
        '401':
          description: Not signed in (no member session or Connections key).
        '403':
          description: The key lacks this plane's scope.
      tags:
      - Preferences
      operationId: postPreferences
      x-operation-id-source: derived
    servers:
    - url: https://api.connectionsapi.com/v1
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: 'A Studio-minted cnx_live_ key carrying analytics:read (analytics:write to provision sites). The SAME key is also accepted as Authorization: Bearer (see BearerAuth). Studio is the sole key issuer. The legacy per-plane argus_live_ key class was retired 2026-06-21.'
    memberSession:
      type: http
      scheme: bearer
      description: The member's Connections session access token, exactly as this product's app sends it. Only operations that declare this scheme accept one.
      x-connections-credential: member-session
    cnxKey:
      type: http
      scheme: bearer
      description: A cnx_live_ key minted in Studio. It acts as the member who minted it, within its scopes.
      x-connections-credential: connections-key
    BearerAuth:
      type: http
      scheme: bearer
      description: A cnx_live_ key carrying analytics:read, sent as a bearer token.
    ApiKey:
      type: http
      scheme: bearer
      description: Connections workspace API key.
      x-connections-credential: connections-key
    OAuth2:
      type: http
      scheme: bearer
      description: Connections OAuth access token.
      x-connections-credential: oauth-access-token
    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-analytics-openapi-original.json
- connections-icu-events-openapi-original.json
- connections-icu-product-openapi-original.json
- connections-icu-studio-openapi-original.json
- connections-icu-analytics-openapi.yml
- connections-icu-events-openapi.yml
- connections-icu-product-openapi.yml
- connections-icu-studio-openapi.yml