Formasty Me API

openapi: 3.2.0
info:
  title: Formasty Forms Me API
  version: 1.0.0
  description: Create, inspect, edit, validate, publish, and read Formasty forms with OAuth 2.0 or an account-owned API key.
servers:
- url: https://app.formasty.com/api/v1
security:
- FormastyOAuth: []
- FormastyApiKey: []
tags:
- name: Me
paths:
  /me:
    get:
      operationId: getApiKeyProfile
      x-formasty-required-scope: none
      summary: Validate the authenticated credential
      description: Returns the OAuth or API-key owner, preferred workspace, credential type, and granted scopes.
      responses:
        '200':
          description: Authenticated credential profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyProfileResponse'
        '401':
          description: Missing or invalid credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          $ref: '#/components/responses/AgentError'
      tags:
      - Me
components:
  responses:
    AgentError:
      description: A machine-readable error with a stable code and a recovery hint. The legacy error value is retained for existing clients.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      additionalProperties: true
      required:
      - error
      - code
      - message
      - recovery
      - retryable
      - status
      properties:
        error:
          oneOf:
          - type: string
          - type: object
            additionalProperties: true
          description: Backward-compatible legacy error value. New integrations should branch on the top-level code and display message.
        code:
          type: string
          enum:
          - invalid_request
          - authentication_required
          - permission_denied
          - resource_not_found
          - conflict
          - payload_too_large
          - validation_failed
          - rate_limited
          - internal_error
          - service_unavailable
          description: Stable machine-readable category suitable for programmatic recovery.
        message:
          type: string
          description: Human-readable explanation of what failed.
        recovery:
          type: string
          description: Concrete next action an agent or API client can take.
        retryable:
          type: boolean
          description: Whether retrying later or after the described recovery can succeed.
        status:
          type: integer
          minimum: 400
          maximum: 599
          description: HTTP status mirrored in the JSON body.
        docs_url:
          type: string
          format: uri
          description: Canonical Formasty API error documentation.
    ApiKeyProfileResponse:
      type: object
      additionalProperties: false
      required:
      - owner
      - preferred_workspace
      - credential
      properties:
        owner:
          type: object
          additionalProperties: false
          required:
          - id
          - email
          - username
          properties:
            id:
              type: string
            email:
              type: string
              format: email
            username:
              type: string
        preferred_workspace:
          type: string
        credential:
          type: object
          additionalProperties: true
          required:
          - type
          - workspace_id
          - workspace_name
          - scopes
          properties:
            type:
              type: string
              enum:
              - api_key
              - oauth
            id:
              type: string
            workspace_id:
              type: string
            workspace_name:
              type: string
            name:
              type: string
            prefix:
              type: string
            last4:
              type: string
            scopes:
              type: array
              items:
                type: string
            last_used_at:
              type:
              - integer
              - 'null'
            revoked_at:
              type:
              - integer
              - 'null'
            client_id:
              type: string
            connection_id:
              type: string
  securitySchemes:
    FormastyOAuth:
      type: oauth2
      description: Formasty OAuth authorization-code flow with PKCE and refresh tokens.
      flows:
        authorizationCode:
          authorizationUrl: https://app.formasty.com/oauth/authorize/api/v1
          tokenUrl: https://app.formasty.com/oauth/token
          scopes:
            forms:read: Read forms
            forms:create: Create forms
            forms:update: Update forms
            forms:delete: Delete forms
            forms:publish: Publish forms
            forms:steps:write: Edit steps
            forms:fields:write: Edit fields
            forms:logic:write: Edit logic
            forms:design:write: Edit design
            submissions:read: Read submissions
            submissions:create: Create submissions
            submissions:update: Update submissions
            submissions:delete: Delete submissions
    FormastyApiKey:
      type: http
      scheme: bearer
      bearerFormat: Formasty API key