find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/rulebase:rulebase-search-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Rulebase API2 Search API
  version: 0.0.1
tags:
- name: Search
paths:
  /search:
    get:
      parameters:
      - schema:
          type: string
        required: false
        name: query
        in: query
      - schema:
          type: string
          description: Comma-separated result types. Defaults to all result types.
          example: ticket,work_item,employee,team,brand,board,report,calibration
        required: false
        name: types
        in: query
      - schema:
          type: integer
          minimum: 1
          maximum: 20
        required: false
        name: limit
        in: query
      responses:
        '200':
          description: Search workspace resources
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - knowledge_base_document
                          - membership
                          - employee
                          - customer
                          - company
                          - ticket
                          - work_item
                          - team
                          - brand
                          - board
                          - report
                          - calibration
                          - complaint_type
                          - chat
                        id:
                          type: string
                        title:
                          type: string
                        subtitle:
                          type: string
                          nullable: true
                        url:
                          type: string
                          nullable: true
                        matched_on:
                          type: string
                          enum:
                          - external_id
                          - jira_issue_key
                          - prefix_id
                          - email
                          - name
                          - subject
                          - description
                          - content
                          description: Which column produced the hit.
                        tier:
                          type: integer
                          minimum: 0
                          maximum: 3
                          description: 'Relevance tier, ascending: 0 exact identifier, 1 identifier prefix, 2 full-text, 3 fuzzy. Results are pre-sorted by tier, so clients must not re-rank.'
                        metadata:
                          type: object
                          additionalProperties:
                            nullable: true
                      required:
                      - type
                      - id
                      - title
                      - subtitle
                      - url
                      - matched_on
                      - tier
                      - metadata
                required:
                - data
        '400':
          description: Invalid search request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Search
      summary: Get search
      x-summary-source: derived
      operationId: getSearch
      x-operation-id-source: derived
  /legacy_search:
    get:
      summary: Rails-compatible general search
      description: Compatibility port of the Rails `GET /search` pg_search endpoint (same payload, ranking and policy scope). Distinct from `/search`, the workspace command-menu search.
      tags:
      - Search
      parameters:
      - schema:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        required: false
        name: page[page]
        in: query
      - schema:
          type: integer
          description: Values above 100 are clamped to 100
          minimum: 1
        required: false
        name: page[limit]
        in: query
      - schema:
          type: string
        required: false
        name: query
        in: query
      - schema:
          type: string
          description: Comma-separated Rails searchable types (e.g. `conversation,employee`).
        required: false
        name: type
        in: query
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                          nullable: true
                        type:
                          type: string
                        caption:
                          type: string
                          nullable: true
                      required:
                      - id
                      - name
                      - type
                      - caption
                  meta:
                    type: object
                    properties:
                      page:
                        type: object
                        properties:
                          next:
                            type: number
                            nullable: true
                          limit:
                            type: number
                          total:
                            type: number
                        required:
                        - next
                        - limit
                        - total
                    required:
                    - page
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      operationId: getLegacySearch
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key