Metricool User Settings Service API

The User Settings Service API from Metricool — 2 operation(s) for user settings service.

Operations 2

GET /user/settings Get user settings #
POST /user/unlock Unlock user #

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/metricool:metricool-user-settings-service-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

metricool-user-settings-service-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Metricool User Settings Service API
  description: 'Metricool API


    The base URL for all endpoints is: https://app.metricool.com/api


    All endpoints require authentication.'
  version: 2.0.0
servers:
- url: https://app.metricool.com/api
tags:
- name: User Settings Service
paths:
  /user/settings:
    get:
      tags:
      - User Settings Service
      operationId: getUserSettings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSettings'
      summary: Get user settings
      x-summary-source: derived
  /user/unlock:
    post:
      tags:
      - User Settings Service
      operationId: unlockUser
      responses:
        '200':
          description: OK
      summary: Unlock user
      x-summary-source: derived
components:
  schemas:
    WhiteLabelSettings:
      type: object
      properties:
        iframeMode:
          type: boolean
        enabledChat:
          type: boolean
        footerLogo:
          type: string
        footerLegalUrl:
          type: string
        footerContactUrl:
          type: string
        footerTwitterUrl:
          type: string
        footerFacebookUrl:
          type: string
        footerInstagramUrl:
          type: string
        footerTiktokUrl:
          type: string
        footerYoutubeUrl:
          type: string
        footerPinterestUrl:
          type: string
        loginUrl:
          type: string
        hideMainMenu:
          type: boolean
        showAdsMenu:
          type: boolean
        showPlannerMenu:
          type: boolean
        showSmartLinksMenu:
          type: boolean
        showInboxMenu:
          type: boolean
        showEvolutionMenu:
          type: boolean
        showReportsMenu:
          type: boolean
        showAnalyticsSummaryMenu:
          type: boolean
        showBrandSettingsMenu:
          type: boolean
        showReportingMenu:
          type: boolean
        showReportExample:
          type: boolean
        reportExamplePictureUrl:
          type: string
        showSubscriptionEmail:
          type: boolean
        showMessageBackground:
          type: boolean
        hideBrandedContent:
          type: boolean
        customizedCssUrl:
          type: string
        integratorKey:
          type: string
        colors:
          type: object
          additionalProperties:
            type: string
        themeColorPalette:
          $ref: '#/components/schemas/ThemeColors'
        reportBackgroundUrl:
          type: string
        reportBackgroundCoverUrl:
          type: string
        enabledReportTemplates:
          type: boolean
        customDomainBaseUrl:
          type: string
        customSmtpProperties:
          type: object
          additionalProperties:
            type: string
        customSesFrom:
          type: string
        customSesFromLabel:
          type: string
    SubscriptionPlan:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        billingCycles:
          type: integer
          format: int32
        price:
          type: number
          format: float
        profiles:
          type: integer
          format: int32
        tweets:
          type: integer
          format: int32
        maxPostsPerBrand:
          type: integer
          format: int32
        shareProfiles:
          type: boolean
        whiteLabel:
          type: boolean
        influencers:
          type: boolean
        instagramBioLink:
          type: boolean
        reportTemplate:
          type: boolean
        currency:
          type: string
        reportDownload:
          type: boolean
        historyMaxDays:
          type: integer
          format: int64
        influencersRestrictions:
          $ref: '#/components/schemas/InfluencersRestrictions'
        stripePriceId:
          type: string
        level:
          type: integer
          format: int32
        annualDiscountPercent:
          type: number
          format: float
        maxAICopiesByBrandPerMonth:
          type: integer
          format: int32
        api:
          type: boolean
        dataLockerStudio:
          type: boolean
        zapier:
          type: boolean
        addons:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AddonData'
    TaxData:
      type: object
      properties:
        vatRate:
          type: number
          format: double
        company:
          type: string
        country:
          type: string
        state:
          type: string
        address:
          type: string
        vatNumber:
          type: string
        addOn:
          type: string
    InfluencersRestrictions:
      type: object
      properties:
        twitter:
          type: integer
          format: int32
        facebook:
          type: integer
          format: int32
        youtube:
          type: integer
          format: int32
        instagram:
          type: integer
          format: int32
        twitch:
          type: integer
          format: int32
    CreditNoteData:
      type: object
      properties:
        paymentToRefundId:
          type: string
        paymentToRefundInvoiceNumber:
          type: string
        paymentToRefundDate:
          $ref: '#/components/schemas/DateTimeInfo'
    Subscription:
      type: object
      properties:
        id:
          type: string
        provider:
          type: string
        providerUrl:
          type: string
        userId:
          type: integer
          format: int32
        created:
          type: string
        planId:
          type: string
        status:
          type: string
        paymentMethodToken:
          type: string
        nextPaymentDateInDays:
          type: integer
          format: int32
        nextPaymentDate:
          $ref: '#/components/schemas/DateTimeInfo'
        nextPaymentAmount:
          type: number
          format: float
        taxData:
          $ref: '#/components/schemas/TaxData'
        usedProfiles:
          type: integer
          format: int32
        usedPosts:
          type: integer
          format: int32
        maxProfiles:
          type: integer
          format: int32
        maxPosts:
          type: integer
          format: int32
        maxPostsPerBrand:
          type: integer
          format: int32
        maxAICreditsPerBrand:
          type: integer
          format: int32
        plan:
          $ref: '#/components/schemas/SubscriptionPlan'
        immediatelyCancelable:
          type: boolean
        downgradeSubscription:
          $ref: '#/components/schemas/Subscription'
        addons:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AddonData'
        adhocPlan:
          type: boolean
        trialInProgress:
          type: boolean
    UserSettings:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        lastName:
          type: string
        mail:
          type: string
        language:
          type: string
        timezone:
          type: string
        company:
          type: string
        country:
          type: string
        state:
          type: string
        address:
          type: string
        vat:
          type: string
        subscription:
          $ref: '#/components/schemas/Subscription'
        payment:
          $ref: '#/components/schemas/Payment'
        whiteLabelSettings:
          $ref: '#/components/schemas/WhiteLabelSettings'
        sharedWithUser:
          type: boolean
        vendastaUser:
          type: boolean
        vendastaSettings:
          $ref: '#/components/schemas/VendastaData'
        hashtagBalance:
          type: integer
          format: int32
        vaxRate:
          type: integer
          format: int32
        activeBrands:
          type: integer
          format: int32
        profilePicture:
          type: string
        whiteLabel:
          type: boolean
        beta:
          type: boolean
    VendastaData:
      type: object
      properties:
        accountId:
          type: string
        productNavBarDataUrl:
          type: string
    AddonData:
      type: object
      properties:
        id:
          type: string
          enum:
          - twitter
          - advanced_analytics
          - twitter_2026
          - flows
        quantity:
          type: integer
          format: int32
        version:
          type: string
          enum:
          - v2025
          - v2026
    DateTimeInfo:
      required:
      - dateTime
      type: object
      properties:
        dateTime:
          type: string
          description: 'Local Date-time represented with a certain timezone '
        timezone:
          type: string
          description: Timezone applied to the datetime
    ThemeColors:
      type: object
      properties:
        topMenuBackgroundColor:
          type: string
        topMenuTextColor:
          type: string
        topMenuSeparatorColor:
          type: string
        primaryButtonBackgroundColor:
          type: string
        primaryButtonBorderColor:
          type: string
        primaryButtonTextColor:
          type: string
        secondaryButtonBackgroundColor:
          type: string
        secondaryButtonBorderColor:
          type: string
        secondaryButtonTextColor:
          type: string
        backgroundColor:
          type: string
    Payment:
      type: object
      properties:
        id:
          type: integer
          format: int32
        paymentId:
          type: string
        subscriptionId:
          type: string
        description:
          type: string
        date:
          $ref: '#/components/schemas/DateTimeInfo'
        amount:
          type: number
          format: float
        currency:
          type: string
        periodStart:
          $ref: '#/components/schemas/DateTimeInfo'
        periodEnd:
          $ref: '#/components/schemas/DateTimeInfo'
        eurRate:
          type: number
          format: double
        rateDate:
          $ref: '#/components/schemas/DateTimeInfo'
        invoiceNumber:
          type: string
        paymentType:
          type: string
        taxData:
          $ref: '#/components/schemas/TaxData'
        creditNoteData:
          $ref: '#/components/schemas/CreditNoteData'
        observations:
          type: string
        basePlanAmount:
          type: number
          format: float
        twitterAddonAmount:
          type: number
          format: float
        discountAmount:
          type: number
          format: float
        planDescription:
          type: string
        twitterAddonDescription:
          type: string
        advancedAnalyticsAddonAmount:
          type: number
          format: float
        advancedAnalyticsAddonDescription:
          type: string