Bigtincan

Bigtincan Hub API

The Bigtincan Hub Public API provides programmatic access to the Bigtincan sales enablement platform, enabling management of sales content, training programs, coaching insights, buyer engagement analytics, and CRM content synchronization. Supports OAuth2 authentication with Client ID and Client Secret for generating access tokens.

GitHub OpenAPI

Documentation

📖
Documentation
https://pubapi.bigtincan.com/doc/interactive/
📖
APIReference
https://pubapi.bigtincan.com/doc/interactive/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/authentication/bigtincan-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/rate-limits/bigtincan-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/openapi/bigtincan-hub-api-openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/overlays/bigtincan-hub-api-overlay.yaml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/scopes/bigtincan-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/conventions/bigtincan-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/errors/bigtincan-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/data-model/bigtincan-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/lifecycle/bigtincan-lifecycle.yml
🔗
MCPServer
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/mcp/bigtincan-mcp.yml
🔗
AgentSkill
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/skills/_index.yml
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/plans/bigtincan-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/finops/bigtincan-finops.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/apis.yml

OpenAPI Specification

bigtincan-hub-api-openapi.json Raw ↑ 
{
  "swagger": "2.0",
  "info": {
    "title": "Bigtincan Hub Public API",
    "version": "1.0",
    "description": "The Bigtincan Hub Public API provides programmatic access to the Bigtincan sales enablement platform: stories, files, channels, tabs, groups, users, tags, bookmarks, forms, public file shares, search, CRM story recommendations, interaction tracking and admin management.",
    "contact": {
      "name": "Bigtincan Support",
      "url": "https://www.bigtincan.com/contact/"
    },
    "termsOfService": "https://www.bigtincan.com/eula/"
  },
  "host": "pubapi.bigtincan.com",
  "basePath": "/",
  "schemes": [
    "https"
  ],
  "securityDefinitions": {
    "oauth2_password": {
      "type": "oauth2",
      "flow": "password",
      "tokenUrl": "https://pubapi.bigtincan.com/services/oauth2/token",
      "description": "Client ID + Client Secret + API Key exchanged at /services/oauth2/token with grant_type=password. Returns access_token + refresh_token. The As-User header is available only with this flow. Source: https://pubapi.bigtincan.com/doc/interactive/",
      "scopes": {}
    },
    "oauth2_authorization_code": {
      "type": "oauth2",
      "flow": "accessCode",
      "authorizationUrl": "https://pubapi.bigtincan.com/services/oauth2/authorize",
      "tokenUrl": "https://pubapi.bigtincan.com/services/oauth2/token",
      "description": "Interactive Bigtincan Hub user login. The As-User header is disabled for this flow. Source: https://pubapi.bigtincan.com/doc/interactive/",
      "scopes": {}
    }
  },
  "security": [
    {
      "oauth2_password": []
    },
    {
      "oauth2_authorization_code": []
    }
  ],
  "tags": [
    {
      "name": "Admin"
    },
    {
      "name": "Bookmark"
    },
    {
      "name": "CRM"
    },
    {
      "name": "Channel"
    },
    {
      "name": "Event"
    },
    {
      "name": "File"
    },
    {
      "name": "Form"
    },
    {
      "name": "Group"
    },
    {
      "name": "History"
    },
    {
      "name": "Links"
    },
    {
      "name": "Public File Share"
    },
    {
      "name": "Search"
    },
    {
      "name": "Settings"
    },
    {
      "name": "Story"
    },
    {
      "name": "Tab"
    },
    {
      "name": "Tag"
    },
    {
      "name": "User"
    },
    {
      "name": "User Metadata"
    }
  ],
  "paths": {
    "/v1/bookmarks": {
      "get": {
        "tags": [
          "Bookmark"
        ],
        "summary": "Retrieve Stories and Files bookmark.",
        "description": "Retrieve Stories and Files bookmark.",
        "operationId": "get-v1-bookmarks",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "description": "Filter bookmark by type",
            "required": false,
            "type": "string",
            "default": "all",
            "enum": [
              "story",
              "files",
              "all"
            ]
          },
          {
            "name": "page",
            "in": "query",
            "description": "Pagination: current page",
            "required": false,
            "type": "integer"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination: results per page. Max 100",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "name": "sort_by",
            "in": "query",
            "description": "Sort by fields",
            "required": false,
            "type": "string",
            "default": "name",
            "enum": [
              "name",
              "created_at"
            ]
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Link for the urn entity type"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/channel/all": {
      "get": {
        "tags": [
          "Channel"
        ],
        "summary": "Retrieve channels.",
        "description": "Retrieve channels. Channel access is limited to the requester's group associations.",
        "operationId": "get-v1-channel-all",
        "parameters": [
          {
            "name": "tab_id",
            "in": "query",
            "description": "Tab ID to filter channels",
            "required": false,
            "type": "string"
          },
          {
            "name": "search",
            "in": "query",
            "description": "Key word for searching by channel name",
            "required": false,
            "type": "string"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Pagination: current page",
            "required": false,
            "type": "integer"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination: results per page. Max 100",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "A list of channels"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/channels": {
      "post": {
        "tags": [
          "Channel"
        ],
        "summary": "Retrieve channels by ids.",
        "description": "Channel access is limited by the requester's permissions.",
        "operationId": "post-v1-channels",
        "responses": {
          "200": {
            "description": "List of found channels, channels not found or not allowed are omitted"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "description": "Channels request object",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Get Channels Request"
            }
          }
        ]
      }
    },
    "/v1/admin/channels": {
      "get": {
        "tags": [
          "Admin",
          "Channel"
        ],
        "summary": "Get all admin channels",
        "description": "Retrieve all company channels.",
        "operationId": "get-v1-admin-channels",
        "parameters": [
          {
            "name": "tab_id",
            "in": "query",
            "description": "Tab ID to filter channels",
            "required": false,
            "type": "string"
          },
          {
            "name": "search",
            "in": "query",
            "description": "Key word for searching by channel name",
            "required": false,
            "type": "string"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Pagination: current page",
            "required": false,
            "type": "integer"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination: results per page. Max 100",
            "required": false,
            "type": "integer",
            "default": 10
          }
        ],
        "responses": {
          "200": {
            "description": "A list of channels"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          }
        }
      }
    },
    "/v1/channel/{channel_id}": {
      "delete": {
        "tags": [
          "Channel"
        ],
        "summary": "Delete a channel.",
        "description": "Delete a channel.",
        "operationId": "delete-v1-channel-by-channel-id",
        "parameters": [
          {
            "name": "channel_id",
            "in": "path",
            "description": "Channel ID",
            "required": true,
            "type": "string"
          },
          {
            "name": "archive_stories",
            "in": "query",
            "description": "Whether to archive the stories in the channel",
            "required": false,
            "type": "boolean",
            "default": false
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "204": {
            "description": "Channel deleted."
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          },
          "422": {
            "$ref": "#/responses/422"
          }
        }
      },
      "patch": {
        "tags": [
          "Channel"
        ],
        "summary": "Update a channel.",
        "description": "Update a channel.",
        "operationId": "patch-v1-channel-by-channel-id",
        "parameters": [
          {
            "name": "channel_id",
            "in": "path",
            "description": "Channel id",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "Channel object",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Update channel Request"
            }
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Channel updated"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "422": {
            "description": "Validation error"
          }
        }
      }
    },
    "/v1/channel/personal/add": {
      "post": {
        "tags": [
          "Channel"
        ],
        "summary": "Create a personal channel.",
        "description": "Create a personal channel.",
        "operationId": "post-v1-channel-personal-add",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Add Personal Channel Request"
            }
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Channel object"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "422": {
            "description": "Validation error"
          }
        }
      }
    },
    "/v1/admin/channels/{channel_id}": {
      "patch": {
        "tags": [
          "Admin",
          "Channel"
        ],
        "summary": "Modify a channel",
        "description": "Modify a channel",
        "operationId": "patch-v1-admin-channels-by-channel-id",
        "parameters": [
          {
            "name": "channel_id",
            "in": "path",
            "description": "Channel id",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "Channel object",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Modify channel request"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Channel updated"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          },
          "422": {
            "description": "Validation error"
          }
        }
      }
    },
    "/v1/settings": {
      "get": {
        "tags": [
          "Settings"
        ],
        "summary": "Retrieve settings.",
        "description": "Retrieve settings. Includes: story defaults",
        "operationId": "get-v1-settings",
        "responses": {
          "200": {
            "description": "Settings object"
          },
          "401": {
            "$ref": "#/responses/401"
          }
        }
      }
    },
    "/v1/events": {
      "get": {
        "tags": [
          "Event"
        ],
        "summary": "Retrieve a user's events.",
        "description": "Retrieve a user's events.",
        "operationId": "get-v1-events",
        "parameters": [
          {
            "name": "between[start]",
            "in": "query",
            "description": "Start date filter for events in RFC3339 format",
            "required": true,
            "type": "string",
            "default": "2019-08-01T00:00:00+00:00"
          },
          {
            "name": "between[end]",
            "in": "query",
            "description": "End date filter for events in RFC3339 format",
            "required": true,
            "type": "string",
            "default": "2019-08-30T00:00:00+00:00"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination: results per page. Max 100",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "name": "page",
            "in": "query",
            "description": "Pagination: current page",
            "required": false,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "List of events."
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "422": {
            "$ref": "#/responses/422"
          }
        }
      }
    },
    "/v1/files/{file_perm_id}/tags": {
      "post": {
        "tags": [
          "File"
        ],
        "summary": "Add tags to file",
        "description": "Add tags to file",
        "operationId": "post-v1-files-by-file-perm-id-tags",
        "parameters": [
          {
            "name": "file_perm_id",
            "in": "path",
            "description": "File perm id",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "Tags object",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Add tags to file"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Tags added"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          },
          "422": {
            "description": "Validation error"
          }
        }
      }
    },
    "/v1/files/{file_perm_id}": {
      "get": {
        "tags": [
          "File"
        ],
        "summary": "Retrieve file details",
        "description": "Retrieve file details",
        "operationId": "get-v1-files-by-file-perm-id",
        "parameters": [
          {
            "name": "file_perm_id",
            "in": "path",
            "description": "File perm id",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "A file array"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          }
        }
      }
    },
    "/v1/files": {
      "get": {
        "tags": [
          "File"
        ],
        "summary": "Retrieve files",
        "description": "Retrieve files",
        "operationId": "get-v1-files",
        "parameters": [
          {
            "name": "tab_id",
            "in": "query",
            "description": "Tab id",
            "required": false,
            "type": "integer"
          },
          {
            "name": "channel_id",
            "in": "query",
            "description": "Channel id",
            "required": false,
            "type": "integer"
          },
          {
            "name": "dateModified",
            "in": "query",
            "description": "Gets all files after this date",
            "required": false,
            "type": "string"
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "A list of files"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/file/allowed-extensions": {
      "get": {
        "tags": [
          "File"
        ],
        "summary": "Retrieve allowed file extensions",
        "description": "Retrieve allowed file extensions",
        "operationId": "get-v1-file-allowed-extensions",
        "responses": {
          "200": {
            "description": "A list of allowed file extensions"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/form_category/all": {
      "get": {
        "tags": [
          "Form"
        ],
        "summary": "Retrieve form categories.",
        "description": "Retrieve form categories.",
        "operationId": "get-v1-form-category-all",
        "parameters": [
          {
            "name": "include_groups",
            "in": "query",
            "description": "Include groups",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Pagination: current page",
            "required": false,
            "type": "integer"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination: results per page. Max 100",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "A list of form categories"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/form/all": {
      "get": {
        "tags": [
          "Form"
        ],
        "summary": "Retrieve forms.",
        "description": "Retrieve forms.",
        "operationId": "get-v1-form-all",
        "parameters": [
          {
            "name": "category_id",
            "in": "query",
            "description": "Category ID",
            "required": false,
            "type": "string"
          },
          {
            "name": "include_groups",
            "in": "query",
            "description": "Include groups",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Pagination: current page",
            "required": false,
            "type": "integer"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination: results per page. Max 100",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "A list of forms"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/form/get/{form_id}": {
      "get": {
        "tags": [
          "Form"
        ],
        "summary": "Get a form.",
        "description": "Get a form.",
        "operationId": "get-v1-form-get-by-form-id",
        "parameters": [
          {
            "name": "form_id",
            "in": "path",
            "description": "Form ID",
            "required": true,
            "type": "string"
          },
          {
            "name": "include_data_sources",
            "in": "query",
            "description": "Include data sources",
            "required": false,
            "type": "boolean"
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Form object"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/form/data/{form_id}": {
      "get": {
        "tags": [
          "Form"
        ],
        "summary": "Retrieve form data.",
        "description": "Retrieve form data.",
        "operationId": "get-v1-form-data-by-form-id",
        "parameters": [
          {
            "name": "form_id",
            "in": "path",
            "description": "Form ID",
            "required": true,
            "type": "string"
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sort order",
            "required": false,
            "type": "string",
            "enum": [
              "asc",
              "desc"
            ]
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "Form submission ID",
            "required": false,
            "type": "string"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Pagination: current page",
            "required": false,
            "type": "integer"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination: results per page. Max 100",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Form submission data"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/form/get_file/{form_id}/{submission_key}/{filename}": {
      "get": {
        "tags": [
          "Form"
        ],
        "summary": "Get a form file.",
        "description": "Get a form file.",
        "operationId": "get-v1-form-get-file-by-form-id-by-submission-key-by-filename",
        "parameters": [
          {
            "name": "form_id",
            "in": "path",
            "description": "Form ID",
            "required": true,
            "type": "string"
          },
          {
            "name": "submission_key",
            "in": "path",
            "description": "Submission key",
            "required": true,
            "type": "string"
          },
          {
            "name": "filename",
            "in": "path",
            "description": "Filename",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "File download"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/group/all": {
      "get": {
        "tags": [
          "Group"
        ],
        "summary": "Retrieve groups.",
        "description": "Retrieve groups.",
        "operationId": "get-v1-group-all",
        "parameters": [
          {
            "name": "search",
            "in": "query",
            "description": "Search keywords",
            "required": false,
            "type": "string"
          },
          {
            "name": "include_personal_group",
            "in": "query",
            "description": "Include personal groups",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Pagination: current page",
            "required": false,
            "type": "integer"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination: results per page. Max 100",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "A list of groups"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/group": {
      "post": {
        "tags": [
          "Group"
        ],
        "summary": "Create a group.",
        "description": "Create a group.",
        "operationId": "post-v1-group",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "description": "Group object",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Add Group Request"
            }
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "201": {
            "description": "Group object"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/admin/groups/{group_id}": {
      "delete": {
        "tags": [
          "Admin",
          "Group"
        ],
        "summary": "Delete a group.",
        "description": "Delete a group.",
        "operationId": "delete-v1-admin-groups-by-group-id",
        "parameters": [
          {
            "name": "group_id",
            "in": "path",
            "description": "Group ID",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "204": {
            "description": "Group Deleted"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "422": {
            "$ref": "#/responses/422"
          }
        }
      },
      "patch": {
        "tags": [
          "Admin",
          "Group"
        ],
        "summary": "Modify a group.",
        "description": "Modify a group.",
        "operationId": "patch-v1-admin-groups-by-group-id",
        "parameters": [
          {
            "name": "group_id",
            "in": "path",
            "description": "Group id",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "Group object",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Modify Group Request"
            }
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "Group updated"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          },
          "404": {
            "$ref": "#/responses/404"
          },
          "422": {
            "description": "Validation error"
          }
        }
      }
    },
    "/v1/group/{group_id}/users": {
      "put": {
        "tags": [
          "Group"
        ],
        "summary": "Adds users to a group.",
        "description": "Adds users to a group.",
        "operationId": "put-v1-group-by-group-id-users",
        "parameters": [
          {
            "name": "group_id",
            "in": "path",
            "description": "Group ID",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "User ID array",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Add User to Group Request"
            }
          },
          {
            "$ref": "#/definitions/As-User",
            "name": "As-User",
            "in": "header",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "User added to group"
          },
          "400": {
            "$ref": "#/responses/400"
          },
          "401": {
            "$ref": "#/responses/401"
          },
          "403": {
            "$ref": "#/responses/403"
          }
        }
      }
    },
    "/v1/admin/group/get/{group_id}": {
      "get": {
        "tags": [
          "Admin"
        ],
        "summary": "Get a group.",
        "description": "Get a group.",
        "operationId": "get-v1-admin-group-get-by-group-id",
        "parameters": [
          {
            "name": "group_id",
            "in": "path",
            "description": "Group ID",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Group object"
          },
          "401": {
            "$ref": "#/responses/401"
          }
        }
      }
    },
    "/v1/admin/groups/{group_id}/users/{user_id}"

# --- truncated at 32 KB (124 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigtincan/refs/heads/main/openapi/bigtincan-hub-api-openapi.json