WorkOS

WorkOS widgets API

Widget endpoints.

GitHub OpenAPI

Operations 1

POST /widgets/token Generate a Widget Token #

Documentation

📖
Documentation
https://workos.com/docs
📖
APIReference
https://workos.com/docs/reference
📖
RateLimits
https://workos.com/docs/reference/rate-limits

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/workos/refs/heads/main/openapi/workos-widgets-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/workos/openapi-spec

Other Resources

🔗
StatusPage
https://status.workos.com
🔗
ChangeLog
https://workos.com/changelog
🔗
Pricing
https://workos.com/pricing
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/workos/main/plans/workos-plans-pricing.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/workos/main/capabilities/shared/workos.yaml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/workos/refs/heads/main/graphql/workos-graphql.md

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/workos-widgets-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

workos-widgets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: WorkOS admin-portal Widgets API
  description: WorkOS REST API
  version: '1.0'
  contact:
    name: WorkOS
    url: https://workos.com
    email: support@workos.com
  license:
    name: MIT
    url: https://opensource.org/license/MIT
servers:
- url: https://api.workos.com
  description: Production
- url: https://api.workos-test.com
  description: Staging
security:
- bearer: []
tags:
- name: widgets
  description: Widget endpoints.
  x-displayName: Widgets
paths:
  /widgets/token:
    post:
      description: Generate a widget token scoped to an organization and user with the specified scopes.
      operationId: WidgetsPublicController_issueWidgetSessionToken
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WidgetSessionTokenDto'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetSessionTokenResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  properties:
                    message:
                      type: string
                      description: A human-readable description of the error.
                      example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
                  required:
                  - message
                - type: object
                  properties:
                    message:
                      type: array
                      items:
                        type: string
                      description: A list of validation error messages.
                      example:
                      - organization_id must be a string
                    error:
                      type: string
                      description: The error type.
                      example: Bad Request
                  required:
                  - message
                  - error
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: A human-readable description of the error.
                    example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
                required:
                - message
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: A human-readable description of the error.
                    example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
                required:
                - message
      summary: Generate a Widget Token
      tags:
      - widgets
components:
  schemas:
    WidgetSessionTokenDto:
      type: object
      properties:
        organization_id:
          type: string
          description: The ID of the organization to scope the widget session to.
          example: org_01EHZNVPK3SFK441A1RGBFSHRT
        user_id:
          type: string
          description: The ID of the user to issue the widget session token for.
          example: user_01E4ZCR3C56J083X43JQXF3JK5
        scopes:
          type: array
          description: The scopes to grant the widget session.
          items:
            type: string
            enum:
            - widgets:users-table:manage
            - widgets:domain-verification:manage
            - widgets:sso:manage
            - widgets:api-keys:manage
            - widgets:dsync:manage
            - widgets:audit-log-streaming:manage
          example:
          - widgets:users-table:manage
      required:
      - organization_id
    WidgetSessionTokenResponse:
      type: object
      properties:
        token:
          type: string
          description: The widget session token.
          example: eyJhbGciOiJSUzI1NiIsImtpZCI6InNlc3Npb24...
      required:
      - token
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: 'Your WorkOS API key prefixed with `sk_`. Pass it as a Bearer token: `Authorization: Bearer sk_example_123456789`.'
    access_token:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: An SSO access token returned from the Get a Profile and Token endpoint.