Blackbaud Searchlists API

openapi: 3.2.0
info:
  title: Blackbaud Searchlists API
  version: '1.0'
  x-refined-note:
  - x-apievangelist-provenance differs across the merged source definitions and was not carried
  description: 'Operations tagged Searchlists across 2 of this provider''s published API definitions: blackbaud-altru-administration-api-openapi.yml, blackbaud-crm-administration-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sky.blackbaud.com/alt-adnmg
- url: https://api.sky.blackbaud.com/crm-adnmg
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Searchlists
paths:
  /searchlists/{search_list_id}:
    get:
      operationId: LoadSearchList
      summary: Load a search list
      description: Loads an Infinity search list identified by its GUID. The caller supplies the search list ID in the path. Arbitrary additional query-string parameters are passed through as search criteria fields, using the raw Infinity field name and value (no per-field configuration or type conversion). Columns are returned under their raw Infinity field names. Optional context_record_id scopes record-bound searches. Search lists have no session paging; use limit to cap the number of rows returned.
      parameters:
      - name: search_list_id
        in: path
        required: true
        schema:
          type: string
        description: The GUID of the Infinity search list to load.
      - name: context_record_id
        in: query
        required: false
        schema:
          type: string
        description: Optional record GUID for record-scoped search lists.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of rows to return.
      responses:
        '200':
          description: Search list loaded successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Searchlists-search_list_id-Get200ApplicationJsonResponse'
              example:
                count: 0
                value:
                - {}
        '400':
          description: Bad request (e.g. search_list_id is not a valid GUID).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
                trace_id: string
                span_id: string
      tags:
      - Searchlists
    servers:
    - url: https://api.sky.blackbaud.com/alt-adnmg
components:
  schemas:
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          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
          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
          description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
          format: int32
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
        instance:
          type: string
          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: false
      description: A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
      x-display-name: Problem details
      x-display-id: ProblemDetails
    Searchlists-search_list_id-Get200ApplicationJsonResponse:
      type: object
      properties:
        count:
          type: integer
        value:
          type: array
          items:
            type: object
      x-apim-inline: true
  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: {}
x-refined-from:
- blackbaud-altru-administration-api-openapi.yml
- blackbaud-crm-administration-api-openapi.yml