Atomicwork Forms API

The forms API from Atomicwork — 5 operation(s) for forms.

GitHub OpenAPI

Operations 5

GET /api/v1/forms/changes Get change fields applicable (visible) to current user #
GET /api/v1/forms/requests Get request fields applicable (visible) to current user #
GET /api/v1/forms/custom-form-template/{form_id} Get request fields applicable (visible) to current user #
GET /api/v1/forms/{entity_type}/{reference_key}/options Get list of options for the field identified by reference_key #
GET /api/v1/forms/{entity_type}/{reference_key}/entities Get list of options for the field identified by reference_key #

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/atomicwork:atomicwork-forms-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

atomicwork-forms-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Atomicwork Public Forms API
  version: 1.0.0
servers:
- url: https://{tenant}.atomicwork.com
  description: Your Atomicwork tenant
tags:
- name: Forms
paths:
  /api/v1/forms/changes:
    get:
      operationId: forms_getapi_v1_forms_changes
      summary: Get change fields applicable (visible) to current user
      tags:
      - Forms
      parameters:
      - name: workspace_id
        in: query
        description: The workspace id
        required: false
        schema:
          type: integer
          format: int64
      - name: change_template_id
        in: query
        description: The change template ID
        required: false
        schema:
          type: integer
          format: int64
      - name: change_id
        in: query
        description: The change display ID
        required: false
        schema:
          type: string
      - name: view
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsChangesGetParametersView'
      - name: status_value
        in: query
        description: ''
        required: false
        schema:
          type: string
      - name: event_type
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsChangesGetParametersEventType'
      - name: requested_for
        in: query
        description: 'User id the change is being raised for. When this equals the calling user, requestor access settings are enforced instead of agent settings.

          '
        required: false
        schema:
          type: integer
          format: int64
      - name: assigned_to
        in: query
        description: 'User id the change is being assigned to. Create-form fallback for the AR1 rule: when this equals the calling user, the caller is acting as an agent, so self-raise is suppressed and agent settings are served. On a loaded entity the persisted assignee takes precedence.

          '
        required: false
        schema:
          type: integer
          format: int64
      - name: asset_id
        in: query
        description: 'Asset to preselect on the Linked assets field, for forms opened from an asset context. When set and resolvable, that field is returned with default_selection set to this asset and can_fill / can_edit false, so it renders read-only. The frontend must still submit the value. An asset id that is unknown, deleted, or not visible to the caller is ignored: the form is returned normally with no preselection rather than an error.

          '
        required: false
        schema:
          type: integer
          format: int64
      - name: X-Workspace-Id
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forms_getapi_v1_forms_changes_Response_200'
      security:
      - ApiKeyAuth: []
  /api/v1/forms/requests:
    get:
      operationId: forms_getapi_v1_forms_requests
      summary: Get request fields applicable (visible) to current user
      tags:
      - Forms
      parameters:
      - name: request_form_type
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsRequestsGetParametersRequestFormType'
      - name: request_type
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsRequestsGetParametersRequestType'
      - name: supported_objects
        in: query
        description: The supported object type. Takes precedence over request_type if both are provided.
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsRequestsGetParametersSupportedObjects'
      - name: workspace_id
        in: query
        description: The workspace id
        required: false
        schema:
          type: integer
          format: int64
      - name: request_id
        in: query
        description: The request display ID
        required: false
        schema:
          type: string
      - name: service_item_ids
        in: query
        description: The service item ids if service request is being created
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: catalog_item_ids
        in: query
        description: The catalogue item fields if catalogue request is being created, we will depreciate(service_item_ids) this soon.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: channel_type
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsRequestsGetParametersChannelType'
      - name: channel_id
        in: query
        description: ''
        required: false
        schema:
          type: string
          minLength: 3
      - name: view
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsRequestsGetParametersView'
      - name: status_value
        in: query
        description: ''
        required: false
        schema:
          type: string
      - name: requested_for
        in: query
        description: 'User id the request is being raised for. When this equals the calling user, requestor access settings are enforced instead of agent settings.

          '
        required: false
        schema:
          type: integer
          format: int64
      - name: assigned_to
        in: query
        description: 'User id the request is being assigned to. Create-form fallback for the AR1 rule: when this equals the calling user, the caller is acting as an agent, so self-raise is suppressed and agent settings are served. On a loaded entity the persisted assignee takes precedence.

          '
        required: false
        schema:
          type: integer
          format: int64
      - name: asset_id
        in: query
        description: 'Asset to preselect on the Linked assets field, for forms opened from an asset context. When set and resolvable, that field is returned with default_selection set to this asset and can_fill / can_edit false, so it renders read-only. The frontend must still submit the value. An asset id that is unknown, deleted, or not visible to the caller is ignored: the form is returned normally with no preselection rather than an error. Has no effect on request types whose form has no Linked assets field (e.g. service requests).

          '
        required: false
        schema:
          type: integer
          format: int64
      - name: X-Workspace-Id
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forms_getapi_v1_forms_requests_Response_200'
      security:
      - ApiKeyAuth: []
  /api/v1/forms/custom-form-template/{form_id}:
    get:
      operationId: forms_getapi_v1_forms_custom_form_template__form_id
      summary: Get request fields applicable (visible) to current user
      tags:
      - Forms
      parameters:
      - name: form_id
        in: path
        description: The custom form id
        required: true
        schema:
          type: integer
          format: int64
      - name: context_type
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsCustomFormTemplateFormIdGetParametersContextType'
      - name: context_id
        in: query
        description: ''
        required: false
        schema:
          type: integer
          format: int64
      - name: X-Workspace-Id
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forms_getapi_v1_forms_custom_form_template__form_id_Response_200'
      security:
      - ApiKeyAuth: []
  /api/v1/forms/{entity_type}/{reference_key}/options:
    get:
      operationId: forms_getapi_v1_forms__entity_type___reference_key__options
      summary: Get list of options for the field identified by reference_key
      tags:
      - Forms
      parameters:
      - name: entity_type
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersEntityType'
      - name: reference_key
        in: path
        description: The reference key of a dropdown, multi dropdown, nested dropdown field
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      - name: workspace_id
        in: query
        description: The workspace id
        required: false
        schema:
          type: integer
          format: int64
      - name: request_sub_type
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersRequestSubType'
      - name: request_id
        in: query
        description: The request display ID
        required: false
        schema:
          type: string
      - name: entity_id
        in: query
        description: The service item id in case entity_type is SERVICE_ITEM
        required: false
        schema:
          type: integer
          format: int64
      - name: parent_option_id
        in: query
        description: ''
        required: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: search_key
        in: query
        description: ''
        required: false
        schema:
          type: string
          minLength: 1
      - name: selected_option_ids
        in: query
        description: ''
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: page
        in: query
        description: ''
        required: true
        schema:
          type: integer
          minimum: 1
          default: 1
      - name: per_page
        in: query
        description: ''
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 25
      - name: view
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersView'
      - name: is_flattened_nested_field_required
        in: query
        description: ''
        required: false
        schema:
          type: boolean
          default: false
      - name: include_any
        in: query
        description: ''
        required: false
        schema:
          type: boolean
          default: false
      - name: is_value_required_as_id
        in: query
        description: ''
        required: false
        schema:
          type: boolean
          default: false
      - name: field_entity_source
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersFieldEntitySource'
      - name: external_field_type
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersExternalFieldType'
      - name: X-Workspace-Id
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forms_getapi_v1_forms__entity_type___reference_key__options_Response_200'
      security:
      - ApiKeyAuth: []
  /api/v1/forms/{entity_type}/{reference_key}/entities:
    get:
      operationId: forms_getapi_v1_forms__entity_type___reference_key__entities
      summary: Get list of options for the field identified by reference_key
      tags:
      - Forms
      parameters:
      - name: entity_type
        in: path
        description: ''
        required: true
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersEntityType'
      - name: reference_key
        in: path
        description: The reference key of a entity reference field
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      - name: workspace_id
        in: query
        description: The workspace id
        required: false
        schema:
          type: integer
          format: int64
      - name: request_type
        in: query
        description: 'Optional request type(s) to scope options by. Comma-separated (e.g.

          request_type=REQUEST,INCIDENT). For status this returns the union of statuses mapped to

          any of the given types (de-duplicated). Omitting it returns options for all types

          (backward compatible). A single value behaves exactly as before.

          '
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersRequestTypeSchemaItems'
      - name: request_id
        in: query
        description: The request display id
        required: false
        schema:
          type: string
      - name: entity_id
        in: query
        description: The service item id in case entity_type is SERVICE_ITEM
        required: false
        schema:
          type: integer
          format: int64
      - name: parent_option_id
        in: query
        description: The parent option ID to query for child options
        required: false
        schema:
          type: integer
          format: int64
      - name: search_key
        in: query
        description: ''
        required: false
        schema:
          type: string
          minLength: 1
      - name: selected_options_ids
        in: query
        description: Deprecated, DO NOT USE. This was a typo. Use selected_option_ids instead.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: selected_option_ids
        in: query
        description: ''
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: is_flattened_nested_field_required
        in: query
        description: ''
        required: false
        schema:
          type: boolean
          default: false
      - name: page
        in: query
        description: ''
        required: true
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 1
      - name: per_page
        in: query
        description: ''
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 1000
          default: 25
      - name: view
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersView'
      - name: is_workspace_member
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      - name: subview
        in: query
        description: ''
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersSubview'
      - name: should_have_system_user
        in: query
        description: Include system users and bots in the response (SYSTEM and ATOMIC_BOT types)
        required: false
        schema:
          type: boolean
          default: false
      - name: user_type
        in: query
        description: 'Narrows the assignee/agent picker to a single user category. EMPLOYEE returns human

          users only, AI_EMPLOYEE returns AI coworkers only. These are the only two values used by

          the picker tabs. When omitted, humans and AI coworkers are returned together (current

          behavior). Any other enum value (e.g. EXTERNAL) is filtered as-is and yields no assignable

          users, since external users are not valid assignees. Applied only to the user-flavoured

          assignee resolution path; ignored for every other entity type.

          '
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersUserType'
      - name: template_id
        in: query
        description: 'Change template ID. When entity_type=CHANGE and reference_key=requester,

          filters the response to workspace members allowed by the template''s

          user_segments (workspace agents always included). Ignored otherwise.

          '
        required: false
        schema:
          type: integer
          format: int64
      - name: X-Workspace-Id
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forms_getapi_v1_forms__entity_type___reference_key__entities_Response_200'
      security:
      - ApiKeyAuth: []
components:
  schemas:
    ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersEntityType:
      type: string
      enum:
      - REQUEST
      - SERVICE_REQUEST
      - QUESTION_REQUEST
      - INCIDENT_REQUEST
      - INCIDENT
      - PROBLEM_REQUEST
      - PROBLEM
      - USER
      - SERVICE_ITEM
      - CUSTOM_FORM
      - SURVEY
      - ASSET
      - CHANGE
      - CHANGE_TEMPLATE
      - CUSTOM_OBJECT
      - STANDALONE
      - EXTERNAL_WEBHOOK
      title: ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersEntityType
    Forms_getapi_v1_forms__entity_type___reference_key__entities_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Forms_getapi_v1_forms__entity_type___reference_key__entities_Response_200
    ApiV1FormsRequestsGetParametersSupportedObjects:
      type: string
      enum:
      - REQUEST
      - SERVICE_REQUEST
      - INCIDENT
      - PROBLEM
      - CHANGE
      title: ApiV1FormsRequestsGetParametersSupportedObjects
    ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersExternalFieldType:
      type: string
      enum:
      - USER
      - PROFORMA
      description: JSM (Jira Service Management) field type identifier
      title: ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersExternalFieldType
    ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersView:
      type: string
      enum:
      - HOME
      - WORKFLOW
      - JOURNEY
      - LIST
      - INSIGHTS
      - CUSTOM_SLA
      - ASSET_LIST
      - RELATIONSHIP_ATTRIBUTE
      - SCHEDULE_WORKFLOW
      - SEARCH
      - NOTIFICATIONS
      - ASSET_RELATIONSHIPS
      - USER_SEGMENTS
      - MULTI_SOURCE_SYNC
      - MAJOR_INCIDENT_CREATE
      - APPROVERS
      - CHANGE_WINDOW
      title: ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersView
    ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersRequestTypeSchemaItems:
      type: string
      enum:
      - REQUEST
      - INCIDENT
      - SERVICE_REQUEST
      - PROBLEM
      - CHANGE
      - MAJOR_INCIDENT
      title: ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersRequestTypeSchemaItems
    ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersEntityType:
      type: string
      enum:
      - REQUEST
      - SERVICE_REQUEST
      - QUESTION_REQUEST
      - INCIDENT_REQUEST
      - INCIDENT
      - PROBLEM_REQUEST
      - PROBLEM
      - USER
      - SERVICE_ITEM
      - CUSTOM_FORM
      - SURVEY
      - ASSET
      - CHANGE
      - CHANGE_TEMPLATE
      - CUSTOM_OBJECT
      - STANDALONE
      - EXTERNAL_WEBHOOK
      title: ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersEntityType
    ApiV1FormsRequestsGetParametersView:
      type: string
      enum:
      - HOME
      - WORKFLOW
      - JOURNEY
      - LIST
      - INSIGHTS
      - CUSTOM_SLA
      - ASSET_LIST
      - RELATIONSHIP_ATTRIBUTE
      - SCHEDULE_WORKFLOW
      - SEARCH
      - NOTIFICATIONS
      - ASSET_RELATIONSHIPS
      - USER_SEGMENTS
      - MULTI_SOURCE_SYNC
      - MAJOR_INCIDENT_CREATE
      - APPROVERS
      - CHANGE_WINDOW
      title: ApiV1FormsRequestsGetParametersView
    ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersRequestSubType:
      type: string
      enum:
      - REQUEST
      - INCIDENT
      - SERVICE_REQUEST
      - PROBLEM
      - CHANGE
      - MAJOR_INCIDENT
      title: ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersRequestSubType
    Forms_getapi_v1_forms_requests_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Forms_getapi_v1_forms_requests_Response_200
    ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersFieldEntitySource:
      type: string
      enum:
      - JSM
      - SERVICE_NOW
      - INTERNAL
      title: ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersFieldEntitySource
    ApiV1FormsChangesGetParametersView:
      type: string
      enum:
      - CREATE_CHANGE_FORM
      - CHANGE_DETAILS
      - CHANGE_LIST
      - UPDATE_CHANGE_ATTRIBUTES_ACTION_CONFIG_FORM
      - CHANGE_ATTRIBUTE_PLACEHOLDERS
      - CHANGE_TEMPLATE_ATTRIBUTES_SETTINGS
      title: ApiV1FormsChangesGetParametersView
    ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersSubview:
      type: string
      enum:
      - CONDITION
      title: ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersSubview
    ApiV1FormsCustomFormTemplateFormIdGetParametersContextType:
      type: string
      enum:
      - JOURNEY
      - WORKFLOW
      - CHANGE_TEMPLATE
      - PROBLEM_REQUEST
      - CHANGE
      - REQUEST
      title: ApiV1FormsCustomFormTemplateFormIdGetParametersContextType
    ApiV1FormsRequestsGetParametersChannelType:
      type: string
      enum:
      - SLACK
      - MS_TEAMS
      - EMAIL
      - ATOMICINBOX
      - UNIVERSAL_AGENT
      title: ApiV1FormsRequestsGetParametersChannelType
    ApiV1FormsRequestsGetParametersRequestFormType:
      type: string
      enum:
      - REQUEST
      - QUESTION_REQUEST
      - INCIDENT_REQUEST
      - SERVICE_REQUEST
      - PROBLEM_REQUEST
      title: ApiV1FormsRequestsGetParametersRequestFormType
    ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersUserType:
      type: string
      enum:
      - EMPLOYEE
      - EXTERNAL
      - AI_EMPLOYEE
      title: ApiV1FormsEntityTypeReferenceKeyEntitiesGetParametersUserType
    Forms_getapi_v1_forms_custom_form_template__form_id_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Forms_getapi_v1_forms_custom_form_template__form_id_Response_200
    ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersView:
      type: string
      enum:
      - HOME
      - WORKFLOW
      - JOURNEY
      - LIST
      - INSIGHTS
      - CUSTOM_SLA
      - ASSET_LIST
      - RELATIONSHIP_ATTRIBUTE
      - SCHEDULE_WORKFLOW
      - SEARCH
      - NOTIFICATIONS
      - ASSET_RELATIONSHIPS
      - USER_SEGMENTS
      - MULTI_SOURCE_SYNC
      - MAJOR_INCIDENT_CREATE
      - APPROVERS
      - CHANGE_WINDOW
      title: ApiV1FormsEntityTypeReferenceKeyOptionsGetParametersView
    Forms_getapi_v1_forms__entity_type___reference_key__options_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Forms_getapi_v1_forms__entity_type___reference_key__options_Response_200
    Forms_getapi_v1_forms_changes_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Forms_getapi_v1_forms_changes_Response_200
    ApiV1FormsChangesGetParametersEventType:
      type: string
      enum:
      - CREATE
      - VIEW_OR_UPDATE
      - VIEW
      - UPDATE
      - CLOSE
      title: ApiV1FormsChangesGetParametersEventType
    ApiV1FormsRequestsGetParametersRequestType:
      type: string
      enum:
      - REQUEST
      - INCIDENT
      - SERVICE_REQUEST
      - PROBLEM
      - CHANGE
      - MAJOR_INCIDENT
      title: ApiV1FormsRequestsGetParametersRequestType
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
x-provenance:
  method: harvested
  publisher: Atomicwork
  source: https://support.atomicwork.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)