Common Ninja

Common Ninja Platform API

Common Ninja Platform API (developers.commoninja.com) for managing widgets, widget types, projects, CRM contacts and form submissions, and analytics, called at https://api.commoninja.com/platform/api/v1 with a bearer token. No provider-published OpenAPI was found; the contract is generated from the documentation by API Evangelist (2026-11-04), 16 operations, and is not the provider's own document.

Documentation GitHub OpenAPI

Operations 16

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/commoninja-com:commoninja-com-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.1.0
info:
  title: Common Ninja API
  version: '2026-11-04'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-04: 16 operation(s) read from 23 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Common Ninja has published no machine-readable contract
    that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 16
    documentation: 0
    pages-with-code: 16
    pages-read: 23
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-04'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://developers.commoninja.com/docs/api/crm/submission
  - https://developers.commoninja.com/docs/api/widgets/widget
  - https://developers.commoninja.com/docs/reference/mcp-server
  - https://developers.commoninja.com/docs/api/widgets/widgets-list
  - https://developers.commoninja.com/docs/api/widgets/widget-create
  - https://developers.commoninja.com/docs/api/widgets/widget-delete
  - https://developers.commoninja.com/docs/api/widgets/widget-editor
  - https://developers.commoninja.com/docs/api/widgets/widget-update
  - https://developers.commoninja.com/docs/api/widget-types/widget-type
  - https://developers.commoninja.com/docs/api/widgets/widget-embed-code
  - https://docs.commoninja.com/apis/proxy.md
  - https://developers.commoninja.com/docs/authentication/tokens
  - https://developers.commoninja.com/docs/authentication/authorization
  - https://developers.commoninja.com/docs/category/crm
  - https://developers.commoninja.com/docs/category/widgets
  - https://developers.commoninja.com/docs/category/projects
  - https://developers.commoninja.com/docs/category/analytics
  - https://developers.commoninja.com/docs/api/crm/contacts-list
  - https://developers.commoninja.com/docs/api/crm/submissions-list
  - https://developers.commoninja.com/docs/api/crm/contact
  - https://developers.commoninja.com/docs/api/widget-types/widget-types-list
  - https://developers.commoninja.com/docs/api/widget-types/widget-type-schema
  - https://en.wikipedia.org/wiki/WebSocket
servers:
- url: https://api.commoninja.com
paths:
  /integrations/api/v1/proxy/admin/api/2022-04/gift_cards.json:
    get:
      operationId: get_integrations_api_v1_proxy_admin_api_2022_04_gift_cards_json
      tags:
      - Integrations
      summary: GET /integrations/api/v1/proxy/admin/api/2022-04/gift_cards.json
      x-source: https://docs.commoninja.com/apis/proxy.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X GET "https://api.commoninja.com/integrations/api/v1/proxy/admin/api/2022-04/gift_cards.json"  -H "Authorization: {cn_token}"

          -H "X-CN-User-Access-Token: {access_token}"

          ```'
  /oauth/token:
    post:
      operationId: post_oauth_token
      tags:
      - Oauth
      summary: POST /oauth/token
      x-source: https://developers.commoninja.com/docs/authentication/tokens
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOauthTokenResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=YOUR_REDIRECT_URI"
          "https://api.commoninja.com/oauth/token" const axios = require ( ''axios'' ) ; async function getData ( ) { const data = { client_id
          : ''YOUR_CLIENT_ID'' , client_secret : ''YOUR'
  /platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/contacts:
    get:
      operationId: get_platform_api_v1_projects_894f5aed_29f5_46c5_9f26_022bfccc5292_contacts
      tags:
      - Platform
      summary: GET /platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/contacts
      x-source: https://developers.commoninja.com/docs/api/crm/contacts-list
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1Projects894F5Aed29F546C59F26022Bfccc5292Cont'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/contacts?limit=5"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/contacts''
          , { headers : { ''Authorization'' '
  /platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/contacts/894f5aed-29f5-46c5-9f26-022bfccc5292:
    get:
      operationId: get_platform_api_v1_projects_894f5aed_29f5_46c5_9f26_022bfccc5292_contacts_894f5
      tags:
      - Platform
      summary: GET /platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/contacts/894f5aed-29f5-46c5-9f26-022bfccc5292
      x-source: https://developers.commoninja.com/docs/api/crm/contact
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1Projects894F5Aed29F546C59F26022Bfccc5292Cont2'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/contacts/894f5aed-29f5-46c5-9f26-022bfccc5292"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/contacts/894f'
  /platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/submissions:
    get:
      operationId: get_platform_api_v1_projects_894f5aed_29f5_46c5_9f26_022bfccc5292_submissions
      tags:
      - Platform
      summary: GET /platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/submissions
      x-source: https://developers.commoninja.com/docs/api/crm/submissions-list
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1Projects894F5Aed29F546C59F26022Bfccc5292Subm'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/submissions?limit=5"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/submissions''
          , { headers : { ''Authoriza'
  /platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/submissions/894f5aed-29f5-46c5-9f26-022bfccc5292:
    get:
      operationId: get_platform_api_v1_projects_894f5aed_29f5_46c5_9f26_022bfccc5292_submissions_89
      tags:
      - Platform
      summary: GET /platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/submissions/894f5aed-29f5-46c5-9f26-022bfccc5292
      x-source: https://developers.commoninja.com/docs/api/crm/submission
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1Projects894F5Aed29F546C59F26022Bfccc5292Subm2'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/submissions/894f5aed-29f5-46c5-9f26-022bfccc5292"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/projects/894f5aed-29f5-46c5-9f26-022bfccc5292/submission'
  /platform/api/v1/widget-types:
    get:
      operationId: get_platform_api_v1_widget_types
      tags:
      - Platform
      summary: GET /platform/api/v1/widget-types
      x-source: https://developers.commoninja.com/docs/api/widget-types/widget-types-list
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1WidgetTypesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widget-types?limit=5"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/widget-types''
          , { headers : { ''Authorization'' : ''Bearer ACCESS_TOKEN'' } , params : { limit : 5 } } ) ; return response . data ; } '
  /platform/api/v1/widget-types/countdown:
    get:
      operationId: get_platform_api_v1_widget_types_countdown
      tags:
      - Platform
      summary: GET /platform/api/v1/widget-types/countdown
      x-source: https://developers.commoninja.com/docs/api/widget-types/widget-type
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1WidgetTypesCountdownResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widget-types/countdown"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/widget-types/countdown''
          , { headers : { ''Authorization'' : ''Bearer ACCESS_TOKEN'' } } ) ; return response . data ; } getData ( ) ;'
  /platform/api/v1/widget-types/countdown/schema:
    get:
      operationId: get_platform_api_v1_widget_types_countdown_schema
      tags:
      - Platform
      summary: GET /platform/api/v1/widget-types/countdown/schema
      x-source: https://developers.commoninja.com/docs/api/widget-types/widget-type-schema
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1WidgetTypesCountdownSchemaResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widget-types/countdown/schema"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/widget-types/countdown/schema''
          , { headers : { ''Authorization'' : ''Bearer ACCESS_TOKEN'' } } ) ; return response . data ; }'
  /platform/api/v1/widgets:
    get:
      operationId: get_platform_api_v1_widgets
      tags:
      - Platform
      summary: GET /platform/api/v1/widgets
      x-source: https://developers.commoninja.com/docs/api/widgets/widgets-list
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1WidgetsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widgets?limit=5" const
          axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/widgets''
          , { headers : { ''Authorization'' : ''Bearer ACCESS_TOKEN'' } , params : { limit : 5 } } ) ; return response . data ; } getData ( '
    post:
      operationId: post_platform_api_v1_widgets
      tags:
      - Platform
      summary: POST /platform/api/v1/widgets
      x-source: https://developers.commoninja.com/docs/api/widgets/widget-create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPlatformApiV1WidgetsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostPlatformApiV1WidgetsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" -H "Content-Type: application/json" -d ''{ "name": "New Widget",
          "type": "bracket", "data": {} }'' "https://api.commoninja.com/platform/api/v1/widgets" const axios = require ( ''axios'' ) ; async function
          getData ( ) { const data = { name : ''New Widget'' , type : ''bracket'' , data : { } } ; const response = await axios . post ( ''https://a'
  /platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292:
    delete:
      operationId: delete_platform_api_v1_widgets_894f5aed_29f5_46c5_9f26_022bfccc5292
      tags:
      - Platform
      summary: DELETE /platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292
      x-source: https://developers.commoninja.com/docs/api/widgets/widget-delete
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -X DELETE -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . delete ( ''https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292''
          , { headers : { ''Authorization'' : ''Bearer ACCES'
    get:
      operationId: get_platform_api_v1_widgets_894f5aed_29f5_46c5_9f26_022bfccc5292
      tags:
      - Platform
      summary: GET /platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292
      x-source: https://developers.commoninja.com/docs/api/widgets/widget
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Respo'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292''
          , { headers : { ''Authorization'' : ''Bearer ACCESS_TOKEN'' } } '
    put:
      operationId: put_platform_api_v1_widgets_894f5aed_29f5_46c5_9f26_022bfccc5292
      tags:
      - Platform
      summary: PUT /platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292
      x-source: https://developers.commoninja.com/docs/api/widgets/widget-update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Reque'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Respo'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -X PUT -H "Authorization: Bearer ACCESS_TOKEN" -H "Content-Type: application/json" -d ''{ "name": "Widget
          name updated!" }'' "https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292" const axios = require (
          ''axios'' ) ; async function getData ( ) { const data = { name : ''Widget name updated!'' } ; const response = await axios . put ( ''https://api.commo'
  /platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292/editor:
    get:
      operationId: get_platform_api_v1_widgets_894f5aed_29f5_46c5_9f26_022bfccc5292_editor
      tags:
      - Platform
      summary: GET /platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292/editor
      x-source: https://developers.commoninja.com/docs/api/widgets/widget-editor
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Edito'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292/editor"
          const axios = require ( ''axios'' ) ; async function getData ( ) { const response = await axios . get ( ''https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292/editor''
          , { headers : { ''Authorization'' : ''Bearer ACCE'
  /platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292/embed-code:
    get:
      operationId: get_platform_api_v1_widgets_894f5aed_29f5_46c5_9f26_022bfccc5292_embed_code
      tags:
      - Platform
      summary: GET /platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292/embed-code
      x-source: https://developers.commoninja.com/docs/api/widgets/widget-embed-code
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Embed'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292/embed-code"
          const axios = require ( "axios" ) ; async function getData ( ) { const response = await axios . get ( "https://api.commoninja.com/platform/api/v1/widgets/894f5aed-29f5-46c5-9f26-022bfccc5292/embed-code"
          , { headers : { Authorization : "Beare'
components:
  schemas:
    PostOauthTokenResponse:
      type: object
      properties:
        access_token:
          type: string
        expires_in:
          type: string
        refresh_token:
          type: string
        refresh_token_expires_in:
          type: string
    GetPlatformApiV1Projects894F5Aed29F546C59F26022Bfccc5292Cont:
      type: object
      properties:
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
        page:
          type: integer
        pages:
          type: integer
        docs:
          type: array
          items:
            type: object
            properties:
              contactId:
                type: string
              projectId:
                type: string
              email:
                type: string
              phone:
                type: string
              name:
                type: string
              thumbnail:
                type: string
              address:
                type: string
              company:
                type: string
              source:
                type: string
              notes:
                type: array
                items:
                  type: string
              created:
                type: string
                format: date-time
              updated:
                type: string
                format: date-time
    GetPlatformApiV1Projects894F5Aed29F546C59F26022Bfccc5292Cont2:
      type: object
      properties:
        contactId:
          type: string
        projectId:
          type: string
        email:
          type: string
        phone:
          type: string
        name:
          type: string
        thumbnail:
          type: string
        address:
          type: string
        company:
          type: string
        source:
          type: string
        notes:
          type: array
          items:
            type: string
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
    GetPlatformApiV1Projects894F5Aed29F546C59F26022Bfccc5292Subm:
      type: object
      properties:
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
        page:
          type: integer
        pages:
          type: integer
        docs:
          type: array
          items:
            type: object
            properties:
              submissionId:
                type: string
              projectId:
                type: string
              widgetId:
                type: string
              type:
                type: string
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    label:
                      type: string
                    value:
                      type: string
                    _id:
                      type: string
              created:
                type: string
                format: date-time
              updated:
                type: string
                format: date-time
    GetPlatformApiV1Projects894F5Aed29F546C59F26022Bfccc5292Subm2:
      type: object
      properties:
        submissionId:
          type: string
        projectId:
          type: string
        widgetId:
          type: string
        type:
          type: string
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              label:
                type: string
              value:
                type: string
              _id:
                type: string
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
    GetPlatformApiV1WidgetTypesResponse:
      type: object
      properties:
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
        page:
          type: integer
        pages:
          type: integer
        docs:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              slug:
                type: string
              buttonText:
                type: string
              teaser:
                type: string
              logo:
                type: string
              promotionImage:
                type: string
              categories:
                type: array
                items:
                  type: string
    GetPlatformApiV1WidgetTypesCountdownResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        buttonText:
          type: string
        teaser:
          type: string
        logo:
          type: string
        promotionImage:
          type: string
        categories:
          type: array
          items:
            type: string
    GetPlatformApiV1WidgetTypesCountdownSchemaResponse:
      type: object
      properties:
        $ref:
          type: string
    GetPlatformApiV1WidgetsResponse:
      type: object
      properties:
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
        page:
          type: integer
        pages:
          type: integer
        docs:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              description:
                type: string
              type:
                type: string
              projectId:
                type: string
              previewImage:
                type: string
              status:
                type: string
              modelVersion:
                type: integer
              created:
                type: string
                format: date-time
              updated:
                type: string
                format: date-time
    PostPlatformApiV1WidgetsRequest:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        data:
          type: object
    PostPlatformApiV1WidgetsResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        type:
          type: string
        previewImage:
          type: string
        projectId:
          type: string
        status:
          type: string
        modelVersion:
          type: integer
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        data:
          type: object
        embedCode:
          type: object
          properties:
            html:
              type: string
            script:
              type: string
        editorUrl:
          type: string
    GetPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Respo:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        type:
          type: string
        projectId:
          type: string
        previewImage:
          type: string
        status:
          type: string
        modelVersion:
          type: integer
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        data:
          type: object
    PutPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Reque:
      type: object
      properties:
        name:
          type: string
    PutPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Respo:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        type:
          type: string
        projectId:
          type: string
        previewImage:
          type: string
        status:
          type: string
        modelVersion:
          type: integer
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        data:
          type: object
    GetPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Edito:
      type: object
      properties:
        url:
          type: string
    GetPlatformApiV1Widgets894F5Aed29F546C59F26022Bfccc5292Embed:
      type: object
      properties:
        html:
          type: string
        script:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Integrations
- name: Oauth
- name: Platform

Common Ninja Platform API

Operations 16

Documentation

Specifications

Schemas & Data

Other Resources