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-settings-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Connections Icu Settings API
  version: 1.0.0
  description: 'Operations tagged Settings across 2 of this provider''s published API definitions: connections-icu-product-openapi-original.json, connections-icu-product-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.connectionsapi.com/v1
security:
- ApiKey: []
- OAuth2: []
tags:
- name: Settings
paths:
  /settings/digest:
    patch:
      summary: Set the follow-up digest send hour and time zone
      description: Send either field alone; the other keeps its stored value. send_hour null returns the digest to its usual time and keeps the zone.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberDigestSettingsWriteInput'
      responses:
        '200':
          description: The stored settings after the write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberDigestSettingsResponse'
        '400':
          description: A value the setting does not accept, or nothing to save.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Credential is missing the contacts:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such setting, or the thing it applies to is not yours.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKey:
        - contacts:write
      - OAuth2:
        - contacts:write
      tags:
      - Settings
      operationId: patchSettingsDigest
      x-operation-id-source: derived
    servers:
    - url: https://api.connectionsapi.com/v1
  /settings/profile:
    patch:
      summary: Set your broadcast city, who sees it, and your app language
      description: Send any field alone; the others keep their stored values. Writes only your profile.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberProfileSettingsWriteInput'
      responses:
        '200':
          description: The stored settings after the write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberProfileSettingsResponse'
        '400':
          description: A value the setting does not accept, or nothing to save.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Credential is missing the contacts:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such setting, or the thing it applies to is not yours.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKey:
        - contacts:write
      - OAuth2:
        - contacts:write
      tags:
      - Settings
      operationId: patchSettingsProfile
      x-operation-id-source: derived
    servers:
    - url: https://api.connectionsapi.com/v1
  /settings/recording-stations/{station}:
    patch:
      summary: Set one recording station to ask first or off
      description: Sets one station; the other stations keep their choice. A station never set reads as ask.
      parameters:
      - name: station
        in: path
        required: true
        schema:
          type: string
          enum:
          - follow_up
          - contact_details
          - calendar
          - todo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordingStationBiasWriteInput'
      responses:
        '200':
          description: The stored settings after the write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingStationBiasesResponse'
        '400':
          description: A value the setting does not accept, or nothing to save.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Credential is missing the contacts:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such setting, or the thing it applies to is not yours.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKey:
        - contacts:write
      - OAuth2:
        - contacts:write
      tags:
      - Settings
      operationId: patchSettingsRecordingStationsByStation
      x-operation-id-source: derived
    servers:
    - url: https://api.connectionsapi.com/v1
  /settings/enrichment-providers/{provider}:
    patch:
      summary: Turn a connected contact-enrichment provider on or off
      description: Only for a provider you already connected in the app; its stored API key is kept.
      parameters:
      - name: provider
        in: path
        required: true
        schema:
          type: string
          example: hunter
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrichmentProviderWriteInput'
      responses:
        '200':
          description: The stored settings after the write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrichmentProviderResponse'
        '400':
          description: A value the setting does not accept, or nothing to save.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Credential is missing the contacts:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such setting, or the thing it applies to is not yours.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKey:
        - contacts:write
      - OAuth2:
        - contacts:write
      tags:
      - Settings
      operationId: patchSettingsEnrichmentProvidersByProvider
      x-operation-id-source: derived
    servers:
    - url: https://api.connectionsapi.com/v1
components:
  schemas:
    EnrichmentProviderResponse:
      type: object
      properties:
        provider:
          type: object
          properties:
            provider:
              type: string
            is_enabled:
              type: boolean
            has_key:
              type: boolean
            key_preview:
              type: string
            last_validated_at:
              type:
              - string
              - 'null'
            last_used_at:
              type:
              - string
              - 'null'
            last_error:
              type: string
            updated_at:
              type: string
    MemberProfileSettingsWriteInput:
      type: object
      additionalProperties: false
      properties:
        broadcast_city_scope:
          type: string
          enum:
          - 'off'
          - mutuals
          - event_hosts
          - all
          description: 'Who sees your broadcast city: off, mutuals (mutual connections), event_hosts (hosts of your events) or all.'
          x-setting:
            id: connections.broadcast_city_scope
            label: Who sees my city
            synonyms:
            - broadcast city
            - share my city
            - city visibility
            - location sharing
            scope: account
            group: Privacy
        broadcast_city:
          type:
          - string
          - 'null'
          maxLength: 80
          description: The city shown to the people chosen in broadcast_city_scope, e.g. Houston; null clears it.
          x-setting:
            id: connections.broadcast_city
            label: My broadcast city
            synonyms:
            - my city
            - current city
            - city I am in
            - location
            scope: account
            group: Privacy
        preferred_locale:
          type: string
          enum:
          - en-US
          - es-419
          description: 'The app language: en-US (English) or es-419 (Latin American Spanish).'
          x-setting:
            id: connections.preferred_locale
            label: App language
            synonyms:
            - language
            - locale
            - spanish
            - english
            scope: account
            group: Account
    EnrichmentProviderWriteInput:
      type: object
      additionalProperties: false
      required:
      - is_enabled
      properties:
        is_enabled:
          type: boolean
          x-setting:
            id: connections.enrichment_provider_enabled
            label: Contact enrichment provider on or off
            synonyms:
            - enrichment provider
            - contact enrichment
            - data provider
            - enrich contacts
            scope: enrichment_provider
            group: Privacy and providers
            scopeParam: provider
    MemberDigestSettingsWriteInput:
      type: object
      additionalProperties: false
      properties:
        send_hour:
          type:
          - integer
          - 'null'
          minimum: 0
          maximum: 23
          description: Local hour 0-23 in time_zone; null = the usual time.
          x-setting:
            id: connections.digest_send_hour
            label: Daily digest send hour
            synonyms:
            - digest time
            - follow-up digest hour
            - email digest time
            - when the digest arrives
            scope: account
            group: Email preferences
        time_zone:
          type: string
          description: IANA zone, e.g. America/Chicago.
          x-setting:
            id: connections.digest_time_zone
            label: Digest time zone
            synonyms:
            - time zone
            - timezone
            - my time zone
            - digest zone
            scope: account
            group: Email preferences
    ErrorResponse:
      type: object
      description: Standard error payload returned by the Connections Developer API.
      required:
      - error
      properties:
        error:
          type: string
    MemberProfileSettingsResponse:
      type: object
      properties:
        profile:
          type: object
          properties:
            broadcast_city_scope:
              type:
              - string
              - 'null'
            broadcast_city:
              type:
              - string
              - 'null'
            broadcast_city_updated_at:
              type:
              - string
              - 'null'
            preferred_locale:
              type:
              - string
              - 'null'
    RecordingStationBiasWriteInput:
      type: object
      additionalProperties: false
      required:
      - bias
      properties:
        bias:
          type: string
          enum:
          - ask
          - 'off'
          description: ask = ask before filing a voice note there; off = never file there.
          x-setting:
            id: connections.recording_station_bias
            label: Recording station
            synonyms:
            - voice note routing
            - recording stations
            - ask before filing
            - turn off station
            scope: recording_station
            group: Recording stations
            scopeParam: station
    RecordingStationBiasesResponse:
      type: object
      properties:
        biases:
          type: object
          additionalProperties:
            type: string
            enum:
            - ask
            - 'off'
    MemberDigestSettingsResponse:
      type: object
      properties:
        settings:
          type: object
          properties:
            send_hour:
              type:
              - integer
              - 'null'
            time_zone:
              type:
              - string
              - 'null'
  securitySchemes:
    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
    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
x-refined-from:
- connections-icu-product-openapi-original.json
- connections-icu-product-openapi.yml