Blackbaud Queryfields API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: Query Queryfields API'
  description: This API supports defining and executing queries for NXT products
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/query
    method: assembled from Blackbaud's public API Management developer data API (operations, parameters, representations, examples, stored definitions); nothing authored
    assembled: '2026-10-14'
servers:
- url: https://api.sky.blackbaud.com/query
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Queryfields
paths:
  /queryfields/{query_field_id}/lookupvalues:
    get:
      operationId: GetLookupValues
      summary: Get lookup values
      description: Gets the list of lookup values for a field.
      parameters:
      - name: query_field_id
        in: path
        required: true
        schema:
          type: integer
        description: The query field ID.
      - name: product
        in: query
        required: true
        schema:
          type: string
          enum:
          - RE
          - FE
        description: The Blackbaud product for the request<p>Members:</p><ul><li><i>RE</i> - The Raiser's Edge</li><li><i>FE</i> - The Financial Edge</li></ul>
      - name: module
        in: query
        required: true
        schema:
          type: string
          enum:
          - None
          - GeneralLedger
          - AccountsPayable
          - AccountsReceivable
          - FixedAssets
          - CashReceipts
        description: The module for the request (RE requests must use 'None', FE requests require one of the other values)<p>Members:</p><ul><li><i>None</i></li><li><i>GeneralLedger</i></li><li><i>AccountsPayable</i></li><li><i>AccountsReceivable</i></li><li><i>FixedAssets</i></li><li><i>CashReceipts</i></li></ul>
      - name: unique_id
        in: query
        required: false
        schema:
          type: string
        description: The attribute type ID, or the specific type ID
      - name: include_inactive
        in: query
        required: false
        schema:
          type: boolean
        description: Whether to include inactive code table entries. Defaults to true. Only applies to RE code table fields.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: '500'
        description: Represents the number of records to return.
      - name: offset
        in: query
        required: false
        schema:
          type: integer
        description: Represents the number of records to skip.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLookupValuesResponse'
              example:
                lookup_values:
                - id: '1'
                  description: Business
                - id: '2'
                  description: Billing
                count: 2
                limit: 500
                offset: 0
        '403':
          description: Returned when the request does not support lookup or the user does not have permission to access the resource.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: urn:blackbaud:forbidden
                title: The requested action is forbidden.
                status: 403
                trace_id: 0092384aa2c24842a550a0137bbf3172
                span_id: f7c9d108335d479588f5f165ca17a5e3
        '404':
          description: Returned when the requested query field ID does not exist.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: urn:blackbaud:resource-not-found
                title: The requested resource could not be found.
                status: 404
                trace_id: 0092384aa2c24842a550a0137bbf3172
                span_id: f7c9d108335d479588f5f165ca17a5e3
      tags:
      - Queryfields
components:
  schemas:
    GetLookupValuesResponse:
      required:
      - limit
      - offset
      type: object
      properties:
        lookup_values:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LookupValue'
          description: The set of values for a lookup field
        count:
          type: integer
          description: The total number of values available for the lookup field
          format: int32
        limit:
          type: integer
          description: The number of values returned based on the limit
          format: int32
        offset:
          type: integer
          description: The offset
          format: int32
      additionalProperties: false
      description: Get a set of lookup values
      x-bb-suppressions:
      - list_operation_pagination_style
    LookupValue:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The ID for the value.
        description:
          type:
          - string
          - 'null'
          description: The description of the value.
      additionalProperties: false
      description: Model for a lookup value
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
        title:
          type:
          - string
          - 'null'
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
        status:
          type:
          - integer
          - 'null'
          description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
          format: int32
        detail:
          type:
          - string
          - 'null'
          description: A human-readable explanation specific to this occurrence of the problem.
        instance:
          type:
          - string
          - 'null'
          description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
        trace_id:
          type: string
          description: A request ID that can be provided to Blackbaud Support that may help with further troubleshooting.
        span_id:
          type: string
          description: A request ID that can be provided to Blackbaud Support that may help with further troubleshooting.
      additionalProperties: {}
      description: A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
  securitySchemes:
    Bb-Api-Subscription-Key:
      type: apiKey
      name: Bb-Api-Subscription-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.blackbaud.com/oauth/authorize
          tokenUrl: https://oauth2.sky.blackbaud.com/token
          scopes: {}