> ## Documentation Index
> Fetch the complete documentation index at: https://help.nextmatter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Details of form field

> 
Show details of a form field including all instances the field is used in.

Page size is 100 by default, 500 maximum. To paginate, follow the standard usage of limit and page parameters.

We strongly recommend using filters with this endpoint and limiting the number of results, especially when requests are frequent. Otherwise, performance might degrade.





## OpenAPI

````yaml /reference/openapi.json get /processes/{process_id}/steps/{step_id}/actions/{action_id}/
openapi: 3.0.1
info:
  title: Next Matter API
  description: >-
    # Introduction

    This is reference documentation for the Next Matter API. It is a RESTful API
    that can be interacted with by sending JSON-formatted requests. Responses
    are also returned in a JSON format.

            The API doesn't expose any endpoints of the workflow editor.
            This means you can't use this API to edit the underlying workflow structure or change definitions.
     # Testing a request

            Use a third party client, such as curl, Postman, or Advanced REST Client, to test our REST API.
  termsOfService: https://www.nextmatter.com/terms-of-service
  contact:
    email: development@nextmatter.com
  version: v1
  x-logo:
    url: >-
      https://assets-global.website-files.com/5fcecdf27451306b2081fedc/5ff43812707834743db939be_NextMatter_Logo_Horizontal.svg
    backgroundColor: '#FFFFFF'
    altText: Next Matter logo
servers:
  - url: https://core.nextmatter.com/api
security:
  - Bearer: []
paths:
  /processes/{process_id}/steps/{step_id}/actions/{action_id}/:
    get:
      tags:
        - Form field
      summary: Details of form field
      description: >+

        Show details of a form field including all instances the field is used
        in.


        Page size is 100 by default, 500 maximum. To paginate, follow the
        standard usage of limit and page parameters.


        We strongly recommend using filters with this endpoint and limiting the
        number of results, especially when requests are frequent. Otherwise,
        performance might degrade.

      operationId: processes_steps_actions_read
      parameters:
        - name: process_id
          in: path
          required: true
          schema:
            type: string
        - name: step_id
          in: path
          required: true
          schema:
            type: string
        - name: action_id
          in: path
          required: true
          schema:
            type: string
        - name: organization
          in: query
          description: organization
          schema:
            type: string
        - name: process
          in: query
          description: process
          schema:
            type: string
        - name: lead_user
          in: query
          description: lead_user
          schema:
            type: string
        - name: progress
          in: query
          description: progress
          schema:
            type: string
        - name: id
          in: query
          description: id
          schema:
            type: string
        - name: ordering
          in: query
          description: Ordering
          schema:
            type: string
            enum:
              - name
              - '-name'
              - started_time
              - '-started_time'
              - last_updated_time
              - '-last_updated_time'
              - status
              - '-status'
              - priority
              - '-priority'
              - progress
              - '-progress'
              - deadline
              - '-deadline'
              - ended_time
              - '-ended_time'
              - total_runtime
              - '-total_runtime'
        - name: status
          in: query
          description: status
          schema:
            type: string
            enum:
              - running
              - completed
              - aborted
        - name: name
          in: query
          description: name
          schema:
            type: string
        - name: query
          in: query
          description: query
          schema:
            type: string
        - name: priority
          in: query
          description: priority
          schema:
            type: string
            enum:
              - V
              - H
        - name: started_time
          in: query
          description: started_time
          schema:
            type: string
        - name: last_updated_time
          in: query
          description: last_updated_time
          schema:
            type: string
        - name: deadline
          in: query
          description: deadline
          schema:
            type: string
        - name: step_deadline
          in: query
          description: step_deadline
          schema:
            type: string
        - name: aborted_time
          in: query
          description: aborted_time
          schema:
            type: string
        - name: completed_time
          in: query
          description: completed_time
          schema:
            type: string
        - name: ended_time
          in: query
          description: ended_time
          schema:
            type: string
        - name: total_runtime_min
          in: query
          description: total_runtime_min
          schema:
            type: string
        - name: total_runtime_max
          in: query
          description: total_runtime_max
          schema:
            type: string
        - name: active_step_id
          in: query
          description: active_step_id
          schema:
            type: string
        - name: tags
          in: query
          description: tags
          schema:
            type: string
        - name: instance_ids
          in: query
          description: instance_ids
          schema:
            type: string
        - name: page
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: page_size
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                  - count
                  - results
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type: string
                    format: uri
                    nullable: true
                  previous:
                    type: string
                    format: uri
                    nullable: true
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ActionInstance'
components:
  schemas:
    ActionInstance:
      required:
        - instance_id
      type: object
      properties:
        value:
          title: Value
          type: object
          properties: {}
          readOnly: true
        instance_id:
          title: Instance id
          type: integer
        instance_name:
          title: Instance name
          type: string
          readOnly: true
        settings:
          title: Settings
          type: object
          properties: {}
          readOnly: true
  securitySchemes:
    Bearer:
      type: apiKey
      description: >

        Authentication is API key based. As an admin, you can generate an API
        key in Next Matter by going to Company > Next Matter API keys.


        When sending requests to the API, authenticate by passing the API key in
        the "Authorization"

        HTTP header, prepended with the string "Api-Key ".


        For example:

         Authorization: Api-Key xyzabc.12fsfe242ubdgakew
      name: Authorization
      in: header
      x-default: Api-Key YOUR_NM_API_KEY

````