vCita Staff Widgets Board API
The Staff Widgets Board API from vCita — 2 operation(s) for staff widgets board.
The Staff Widgets Board API from vCita — 2 operation(s) for staff widgets board.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/vcita:vcita-staff-widgets-board-api"
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.
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: 3.2.0
info:
title: Widgets And Boards Staff Widgets Board 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: Staff Widgets Board
paths:
/v3/apps/staff_widgets_boards:
post:
operationId: StaffWidgetsBoard_create
summary: Create a Staff Widgets Board
description: '## Overview
Creates a widgets board for staff member.
**Uniqueness Constraint**: Each staff member can only have ONE board per `type` value. For example, a staff member cannot have two boards with `type: "home"`. Attempting to create a duplicate returns 403 error: ''Duplication Error: StaffWidgetsBoard Already Exist''.
**Testing Tip**: To reliably test this endpoint, first create a fresh staff member using `POST /platform/v1/businesses/{business_id}/staffs`, then create the board for that new staff.
**Available for Staff Tokens**'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StaffWidgetsBoardRequestDto'
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/staffWidgetsBoard.json
'401':
description: Unauthorized. The bearer token is missing or invalid.
'403':
description: Forbidden. You do not have access to this resource.
tags:
- Staff Widgets Board
security:
- Bearer: []
get:
operationId: StaffWidgetsBoard_getAll
summary: Get all Widgets Boards Of The Staff
description: '## Overview
Returns the widgets boards for staff member.
**Available for Staff Tokens**'
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 type, Example: type=home'
name: type
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/MultiStaffWidgetsBoardResponse'
'401':
description: Unauthorized. The bearer token is missing or invalid.
'403':
description: Forbidden. You do not have access to this resource.
tags:
- Staff Widgets Board
security:
- Bearer: []
/v3/apps/staff_widgets_boards/{uid}:
put:
operationId: StaffWidgetsBoard_update
summary: Update a Staff Widgets Board
description: '## Overview
Update a staff widget board.
**Available for Staff Tokens**'
parameters:
- name: uid
required: true
in: path
description: The staff widgets board UID. **Must be a valid UID from an existing Staff Widgets Board.** Use `GET /v3/apps/staff_widgets_boards` to find valid UIDs. Invalid UIDs will return 404 with message 'StaffWidgetsBoard Not Exist'.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StaffWidgetsBoardRequestDto'
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/staffWidgetsBoard.json
'401':
description: Unauthorized. The bearer token is missing or invalid.
'403':
description: Forbidden. You do not have access to this resource.
tags:
- Staff Widgets Board
security:
- Bearer: []
components:
schemas:
MultiStaffWidgetsBoardResponse:
type: object
properties:
staffWidgetsBoards:
type: array
items:
$ref: https://vcita.github.io/developers-hub/entities/apps/staffWidgetsBoard.json
required:
- staffWidgetsBoards
CustomizedWidgetDimensionsDto:
type: object
properties:
height:
type: integer
width:
type: integer
SectionDto:
type: object
properties:
code_name:
type: string
description: 'The section code name. Common values based on layout: For `MainAndSideBar2Columns` or `MainAndSideBar3Columns` layouts use ''main'' and ''sidebar''. For `SingleColumn` layout use ''main''.'
example: main
widgets:
description: The sections widgets
type: array
items:
$ref: '#/components/schemas/SectionWidgetDto'
required:
- code_name
- widgets
StaffWidgetsBoardRequestDto:
type: object
description: 'Request body for creating or updating a staff widgets board.
**Uniqueness Constraint**: Each staff member can only have ONE board per `type` value. For example, a staff cannot have two ''home'' type boards. Attempting to create a duplicate returns 403: ''Duplication Error: StaffWidgetsBoard Already Exist''.
**To update an existing board**: Use `GET /v3/apps/staff_widgets_boards` to find the board''s UID, then use `PUT /v3/apps/staff_widgets_boards/{uid}`.'
properties:
board_layout_code_name:
type: string
description: A string representing the board layout. Must be unique per staff member when combined with `type`.
enum:
- MainAndSideBar2Columns
- MainAndSideBar3Columns
- SingleColumn
type:
type: string
description: The grid frame of the layout, determines the layout frame containing the board. Must be unique per staff member when combined with `board_layout_code_name`.
enum:
- home
- custom
- dashboard
- analytics
sections:
type: array
description: An array of sections for the widgets board
items:
$ref: '#/components/schemas/SectionDto'
required:
- board_layout_code_name
- type
- sections
SectionWidgetDto:
type: object
properties:
widget_uid:
type: string
description: 'The unique identifier of an existing Widget to include in this section. **Important**: This must be a valid UID from a Widget entity (use `GET /v3/apps/widgets` to find available widgets). Using invalid UIDs will result in a server error.'
dimensions:
description: Custom dimensions for the widget in this section
allOf:
- $ref: '#/components/schemas/CustomizedWidgetDimensionsDto'
required:
- widget_uid
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}'''