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

# Get filter qualifier

> Returns the filter's AI qualifier: the full prompt, model and name, whether it is on, manual or automatic mode, whether disqualified jobs are hidden, what else shares the qualifier, and the credits that pay for it



## OpenAPI

````yaml get /filters/{id}/qualifier
openapi: 3.0.4
info:
  title: Vollna API
  description: API for managing Upwork profiles, proposals, results, and filters
  version: 1.0.0
servers:
  - url: https://api.vollna.com/v1
security: []
tags:
  - name: Profiles
    description: Manage Upwork profiles
  - name: Proposals
    description: Access and manage Upwork proposals
  - name: Results
    description: View monitoring results and projects
  - name: Filters
    description: Manage monitoring filters
  - name: Auto Bidding
    description: Manage auto bidding jobs and setups
  - name: Account
    description: The token team's account, plan and meters
  - name: Invitations
    description: Upwork invitations
  - name: Projects
    description: Upwork jobs and their competition
  - name: AI Qualifier
    description: A filter's AI qualifier and its verdicts
  - name: Market Insights
    description: Upwork market analytics and saved searches
  - name: Proposal Templates
    description: Proposal templates and their results
paths:
  /filters/{id}/qualifier:
    get:
      tags:
        - AI Qualifier
      summary: Get filter qualifier
      description: >-
        Returns the filter's AI qualifier: the full prompt, model and name,
        whether it is on, manual or automatic mode, whether disqualified jobs
        are hidden, what else shares the qualifier, and the credits that pay for
        it
      parameters:
        - name: id
          in: path
          description: Filter ID
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/QualifierSettings'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - apiToken: []
components:
  schemas:
    QualifierSettings:
      type: object
      properties:
        filterId:
          type: integer
        qualifier:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
            prompt:
              type: string
              description: The full prompt
            model:
              type: string
            autoGenerated:
              type: boolean
              description: Vollna wrote the prompt; the first save takes it over
          nullable: true
          description: null when the filter has no qualifier
        enabled:
          type: boolean
        mode:
          type: string
          enum:
            - manual
            - automatic
        showOnlyQualified:
          type: boolean
        promptMaxLength:
          type: integer
          description: Longest prompt the plan allows
        models:
          type: array
          description: Model ids the qualifier can run on
          items:
            type: string
        credits:
          $ref: '#/components/schemas/QualifierCredits'
    QualifierCredits:
      type: object
      description: >-
        The AI qualifier credits that pay for this filter: the pool of the
        qualifier's creator
      properties:
        credits:
          type: object
          properties:
            creditsUsed:
              type: integer
            creditsLimit:
              type: integer
              nullable: true
              description: null is unlimited
            creditsRemaining:
              type: integer
              nullable: true
            extraCreditsRemaining:
              type: number
              description: Purchased credits, spent once the plan credits run out
            totalCreditsRemaining:
              type: number
              nullable: true
            isUnlimited:
              type: boolean
            isFreeTrial:
              type: boolean
            hasCredits:
              type: boolean
            usagePercentage:
              type: number
            period:
              type: object
              properties:
                start:
                  type: string
                  format: date
                  nullable: true
                end:
                  type: string
                  format: date
                  nullable: true
        requiredPerJob:
          type: integer
          description: Credits one job costs on the qualifier's model
        canUse:
          type: boolean
          description: The qualifier can run now
    ServiceError:
      type: object
      properties:
        error:
          type: string
          description: Short error title
          example: Validation failed
        message:
          type: string
          description: What went wrong and what to send instead, written for the user
        fields:
          type: object
          description: >-
            Per-field messages keyed by dot path, when several fields fail at
            once
          additionalProperties:
            type: string
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    BadRequest:
      description: >-
        Invalid request. message says what to send instead; fields names each
        invalid field
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    Unauthorized:
      description: Missing or unknown API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PaymentRequired:
      description: The team's subscription is not active
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The plan has no API access, or the token team may not do this. message
        says why
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    NotFound:
      description: Not found in the token's team
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    TooManyRequests:
      description: More than 30 requests a minute. See Rate Limiting
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiToken:
      type: apiKey
      name: X-API-TOKEN
      in: header
      description: API token for authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.