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

# Get Parameter Options

> Fetches valid options for specific parameters (e.g., transactionTypes, transactionStatuses) to help validate input or populate UI dropdowns. Supports pagination via query parameters.



## OpenAPI

````yaml https://production.hifi.com/api/v2/openapi.json get /v2/reporting/params/{name}/options
openapi: 3.0.0
info:
  title: Hifi API
  version: 2.0.0
  description: API documentation for Hifi
servers:
  - url: https://production.hifibridge.com
    description: Production server
  - url: https://sandbox.hifibridge.com
    description: Sandbox server
security:
  - bearerAuth: []
tags:
  - name: Common
    description: Common endpoints
  - name: User
    description: User endpoints
  - name: Kyc
    description: Kyc endpoints
  - name: Wallet
    description: Wallet endpoints
  - name: Account
    description: Account endpoints
  - name: External Account
    description: External Account endpoints for managing beneficiary bank accounts
  - name: Fiat Account
    description: Fiat Account endpoints
  - name: Virtual Account
    description: Virtual Account endpoints
  - name: Onramp
    description: Onramp endpoints
  - name: Offramp
    description: Offramp endpoints
  - name: Orchestration Address
    description: >-
      Orchestration Address endpoints — persistent on-chain wallets that
      automatically off-ramp incoming stablecoin deposits to a USD bank account
  - name: Crypto Transfer
    description: Crypto Transfer endpoints
  - name: Cross-Chain Bridge
    description: Cross-Chain Bridge endpoints
  - name: Token Swap
    description: Token Swap endpoints
  - name: Canton Offers
    description: Canton Offers endpoints
  - name: Transfer Rules
    description: Transfer approval rules and configuration
  - name: Transfer Approvals
    description: Transfer approval workflow and admin actions
  - name: File
    description: File endpoints
  - name: Reporting
    description: Reporting and metrics endpoints
paths:
  /v2/reporting/params/{name}/options:
    get:
      tags:
        - Reporting
      summary: Get Parameter Options
      description: >-
        Fetches valid options for specific parameters (e.g., transactionTypes,
        transactionStatuses) to help validate input or populate UI dropdowns.
        Supports pagination via query parameters.
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
          description: >-
            The name of the parameter (e.g., transactionTypes,
            transactionStatuses, userIds)
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: Page number for pagination (defaults to 1)
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 1000
          description: Number of items per page (defaults to 100, max 1000)
      responses:
        '200':
          $ref: '#/components/responses/ParamOptionsResponse'
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
components:
  responses:
    ParamOptionsResponse:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ParamOptionsResponse'
          examples:
            ParamOptionsUserIdsExample:
              $ref: '#/components/examples/ParamOptionsUserIdsExample'
            ParamOptionsTransactionTypesExample:
              $ref: '#/components/examples/ParamOptionsTransactionTypesExample'
    BadRequestResponse:
      description: Bad request - validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              error:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  details:
                    type: object
                    description: Field-specific validation errors
    UnauthorizedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    NotFoundResponse:
      description: Resource not found
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              error:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
    InternalServerErrorResponse:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
  schemas:
    ParamOptionsResponse:
      type: object
      description: Paginated list of parameter options
      properties:
        status:
          type: string
          enum:
            - success
        data:
          type: array
          items:
            type: object
            description: Option value and label
            properties:
              value:
                description: Option value (type varies by parameter)
              label:
                type: string
                description: Human-readable option label
        metadata:
          type: object
          properties:
            count:
              type: integer
              description: Total number of options
            page:
              type: integer
              description: Current page number
            limit:
              type: integer
              description: Items per page
            totalPages:
              type: integer
              description: Total number of pages
    Unauthorized:
      type: object
      properties:
        code:
          type: integer
          description: Error code
        error:
          type: string
          description: Error type
        errorDetails:
          type: string
          description: Detailed error message
    InternalServerError:
      type: object
      properties:
        code:
          type: integer
          description: Error code
        error:
          type: string
          description: Error type
        errorDetails:
          type: string
          description: Detailed error message
  examples:
    ParamOptionsUserIdsExample:
      summary: User IDs parameter options (paginated)
      value:
        status: success
        data:
          - f6a78498-0994-5bea-b5ab-7d40a231217a
          - c92f87e6-eaac-59a3-898f-d8c847553f5f
          - fb0b02ed-6bcc-5724-8269-dcaeb6474be2
          - b56ac719-efc3-5e40-b99f-2daf85d519dc
          - 2bbbda5d-0464-5748-801a-dae6ae3dbad9
        metadata:
          count: 5
          page: 1
          limit: 5
          total: 1000
          totalPages: 200
          hasMore: true
    ParamOptionsTransactionTypesExample:
      summary: Transaction types parameter options
      value:
        status: success
        data:
          - onramp
          - offramp
          - transfer
        metadata:
          count: 3
          page: 1
          limit: 10
          total: 3
          totalPages: 1
          hasMore: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````