vCita Widget API

The Widget API from vCita — 2 operation(s) for widget.

GitHub OpenAPI

Operations 3

POST /v3/apps/widgets Create a Widget #
GET /v3/apps/widgets Get all Widgets #
PUT /v3/apps/widgets/{uid} Update Widget #

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/vcita:vcita-widget-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. 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 Specification

vcita-widget-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Widgets And Boards Widget API
  description: 'A set of API endpoints used by the inTandem platform to manage

    App widgets and staff widgets boards.'
  version: '3.0'
  contact: {}
servers:
- url: https://api.vcita.biz/
  description: API Gateway server
tags:
- name: Widget
paths:
  /v3/apps/widgets:
    post:
      operationId: Widgets_create
      summary: Create a Widget
      description: '## Overview

        Create a new widget.


        ## Authentication

        **Available for App Tokens only.** The app must have `app_type=''widgets''` to create widgets. Apps with other types will receive 403: ''This app''s type does not support widgets''.


        ## How to Get an App Token

        1. Use `GET /platform/v1/apps` (with directory token) to find apps with `app_type=''widgets''`

        2. If none exist, create one with `POST /platform/v1/apps` including `app_type: ''widgets''`

        3. Use the app''s `client_id` and `client_secret` to authenticate, or use `GET /platform/v1/tokens` to list app tokens'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWidgetRequestDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    data:
                      type: object
                      $ref: https://vcita.github.io/developers-hub/entities/apps/widget.json
        '401':
          description: Unauthorized. The bearer token is missing or invalid.
        '403':
          description: Forbidden. You do not have access to this resource.
      tags:
      - Widget
      security:
      - Bearer: []
    get:
      operationId: Widgets_getAll
      summary: Get all Widgets
      parameters:
      - name: page
        required: false
        in: query
        description: Page number of results.
        schema:
          minimum: 1
          maximum: 10000
          default: 1
          type: number
      - name: per_page
        required: false
        in: query
        description: 'How many items to return per page. Max: 100'
        schema:
          minimum: 1
          maximum: 100
          default: 25
          type: number
      - description: 'Sort by fields. Example: sort=created_at:asc,updated_at:desc'
        name: sort
        required: false
        in: query
        schema:
          default: updated_at:desc
          type: string
      - description: 'Filter by module, Example: module=Payment'
        name: module
        required: false
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    data:
                      type: object
                      $ref: '#/components/schemas/MultiWidgetsResponse'
        '401':
          description: Unauthorized. The bearer token is missing or invalid.
        '403':
          description: Forbidden. You do not have access to this resource.
      tags:
      - Widget
      security:
      - Bearer: []
      description: '## Overview

        Get all widgets for the authenticated app.


        ## Authentication

        **Available for App Tokens only.** The app must have `app_type=''widgets''` to access widgets. Apps with other types will receive 403: ''This app''s type does not support widgets''.'
  /v3/apps/widgets/{uid}:
    put:
      operationId: Widgets_update
      summary: Update Widget
      description: '## Overview

        Update an existing widget.


        ## Authentication

        **Available for App Tokens only.** The app must have `app_type=''widgets''`. Apps with other types will receive 403: ''This app''s type does not support widgets''.'
      parameters:
      - name: uid
        required: true
        in: path
        description: The widget uid
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWidgetRequestDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    data:
                      type: object
                      $ref: https://vcita.github.io/developers-hub/entities/apps/widget.json
        '401':
          description: Unauthorized. The bearer token is missing or invalid.
        '403':
          description: Forbidden. You do not have access to this resource.
      tags:
      - Widget
      security:
      - Bearer: []
components:
  schemas:
    WidgetDimensionsDto:
      description: The widget dimensions including min\max\preferred height and width.
      type: object
      properties:
        max_height:
          type: integer
        min_height:
          type: integer
        height:
          type: integer
        max_width:
          type: integer
        min_width:
          type: integer
        width:
          type: integer
      required:
      - max_height
      - min_height
      - height
      - max_width
      - min_width
      - width
    CreateWidgetRequestDto:
      type: object
      properties:
        display_name:
          allOf:
          - $ref: '#/components/schemas/DisplayNameDto'
        dimensions:
          allOf:
          - $ref: '#/components/schemas/WidgetDimensionsDto'
        permissions:
          type: array
          description: The permissions required for the widget to show up for a staff member
          items:
            type: string
        module:
          type: string
          description: The module (FF) required for the widget to show up for a staff member
        component_data:
          allOf:
          - $ref: '#/components/schemas/ComponentDataDto'
      required:
      - display_name
      - dimensions
      - component_data
    MultiWidgetsResponse:
      type: object
      properties:
        widgets:
          type: array
          items:
            $ref: https://vcita.github.io/developers-hub/entities/apps/widget.json
      required:
      - widgets
    UpdateWidgetRequestDto:
      type: object
      properties:
        display_name:
          description: The widget display name in different languages
          allOf:
          - $ref: '#/components/schemas/DisplayNameDto'
        component_data:
          description: The widget component data
          allOf:
          - $ref: '#/components/schemas/ComponentDataDto'
        dimensions:
          allOf:
          - $ref: '#/components/schemas/WidgetDimensionsDto'
        permissions:
          type: array
          description: The permissions required for the widget to show up for a staff member
          items:
            type: string
        module:
          type: string
          description: The module (FF) required for the widget to show up for a staff member
    ComponentDataDto:
      type: object
      description: Component data for the widget, specifying the component name and configuration.
      properties:
        name:
          type: string
          description: '**Required.** The component name identifier for the widget.'
        config:
          type: object
          description: Optional configuration object for the widget component.
      required:
      - name
    DisplayNameDto:
      type: object
      properties:
        en:
          type: string
        es:
          type: string
        fr:
          type: string
        it:
          type: string
        pt:
          type: string
        de:
          type: string
        pl:
          type: string
        nl:
          type: string
        he:
          type: string
        sl:
          type: string
      required:
      - en
    Response:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
      required:
      - success
      - data
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''