api-specs/idn/beta/paths/form-definitions-export.yaml

get:
  tags:
    - Custom Forms
  summary: List form definitions by tenant.
  description: No parameters required.
  operationId: exportFormDefinitionsByTenant
  parameters:
    - name: offset
      in: query
      description: |-
        Offset

        Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
        The offset value is record-based, not page-based, and the index starts at 0.
      schema:
        type: integer
        format: int64
        default: 0
        x-go-name: Offset
      example: 0
      required: false
      x-go-name: Offset
    - name: limit
      in: query
      description: |-
        Limit

        Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
        If it is not specified, a default limit is used.
      schema:
        type: integer
        format: int64
        maxLength: 250
        minLength: 0
        default: 250
        x-go-name: Limit
      example: 250
      required: false
      x-go-name: Limit
    - name: filters
      in: query
      description: >-
        Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)


        Filtering is supported for the following fields and operators:
        
        
        **name**: *eq, gt, sw, in*
        
        
        **description**: *eq, gt, sw, in*
        
        
        **created**: *eq, gt, sw, in*
        
        
        **modified**: *eq, gt, sw, in*
      schema:
        type: string
        x-go-name: Filters
      example: name sw "my form"
      required: false
      x-go-name: Filters
    - name: sorters
      in: query
      description: >-
        Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)


        Sorting is supported for the following fields: **name, description, created, modified**
      schema:
        type: string
        default: name
        x-go-name: Sorters
      example: name
      required: false
      x-go-name: Sorters
  responses:
    "200":
      description: Returns a list of form definition objects by tenant used by
        SP-Config
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                object:
                  $ref: '../schemas/forms/FormDefinitionResponse.yaml'
                self:
                  type: string
                  x-go-name: Self
                version:
                  type: integer
                  format: int8
                  x-go-name: Version
    "400":
      description: An error with the request occurred
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
    "401":
      description: An error with the authorization occurred
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
    "403":
      description: An error with the user permissions occurred
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
    "429":
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '../schemas/forms/Error.yaml'
    "500":
      description: An internal server error occurred
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
  security:
    - UserContextAuth:
        - sp:forms:manage