Rulebase

Rulebase Lists API

The Lists API from Rulebase — 7 operation(s) for lists.

GitHub OpenAPI

Operations 12

GET /lists Get lists #
POST /lists Create lists #
GET /lists/column-catalog Get lists column catalog #
GET /lists/{id} Get lists by id #
PATCH /lists/{id} Update lists by id #
DELETE /lists/{id} Delete lists by id #
GET /lists/{id}/companies Get lists by id companies #
GET /lists/{id}/chats Get lists by id chats #
GET /lists/{listId}/views Get lists by list id views #
POST /lists/{listId}/views Create lists by list id views #
PATCH /lists/{listId}/views/{viewId} Update lists by list id views by view id #
DELETE /lists/{listId}/views/{viewId} Delete lists by list id views by view id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-lists-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-qa-agent-evaluation-scorecard-criterion-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-linked-activity-thread-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-scorecard-form-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-evaluation-schedule-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-attempt-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-dry-run-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-lists-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

rulebase-lists-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Lists API
  version: 0.0.1
tags:
- name: Lists
paths:
  /lists:
    get:
      responses:
        '200':
          description: Organization lists
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                        recordType:
                          type: string
                        displayColumns:
                          type: array
                          items:
                            type: string
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                      - id
                      - name
                      - recordType
                      - displayColumns
                      - createdAt
                      - updatedAt
                required:
                - data
      tags:
      - Lists
      summary: Get lists
      x-summary-source: derived
      operationId: getLists
      x-operation-id-source: derived
    post:
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 300
      responses:
        '201':
          description: List created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      recordType:
                        type: string
                      displayColumns:
                        type: array
                        items:
                          type: string
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                    - id
                    - name
                    - recordType
                    - displayColumns
                    - createdAt
                    - updatedAt
                required:
                - data
      tags:
      - Lists
      summary: Create lists
      x-summary-source: derived
      operationId: postLists
      x-operation-id-source: derived
  /lists/column-catalog:
    get:
      responses:
        '200':
          description: Available onboarding list columns
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          enum:
                          - domain
                          - external_id
                          - description
                          - ubo_status
                          - risk_level
                          - onboarding_case_status
                          - document_status
                          - documents_missing
                          - onboarding_status_summary
                          - in_remediation
                          - created_at
                          - updated_at
                        label:
                          type: string
                        description:
                          type: string
                        group:
                          type: string
                          enum:
                          - company
                          - onboarding
                      required:
                      - key
                      - label
                      - description
                      - group
                required:
                - data
      tags:
      - Lists
      summary: Get lists column catalog
      x-summary-source: derived
      operationId: getListsColumnCatalog
      x-operation-id-source: derived
  /lists/{id}:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: List metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      recordType:
                        type: string
                      displayColumns:
                        type: array
                        items:
                          type: string
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                    - id
                    - name
                    - recordType
                    - displayColumns
                    - createdAt
                    - updatedAt
                required:
                - data
        '404':
          description: List not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Get lists by id
      x-summary-source: derived
      operationId: getListsById
      x-operation-id-source: derived
    patch:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 300
                displayColumns:
                  type: array
                  items:
                    type: string
                  minItems: 1
      responses:
        '200':
          description: List updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      recordType:
                        type: string
                      displayColumns:
                        type: array
                        items:
                          type: string
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                    - id
                    - name
                    - recordType
                    - displayColumns
                    - createdAt
                    - updatedAt
                required:
                - data
        '404':
          description: List not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Update lists by id
      x-summary-source: derived
      operationId: patchListsById
      x-operation-id-source: derived
    delete:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '204':
          description: List deleted
        '404':
          description: List not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Delete lists by id
      x-summary-source: derived
      operationId: deleteListsById
      x-operation-id-source: derived
  /lists/{id}/companies:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Companies in list order
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        description:
                          type: string
                          nullable: true
                        domainNames:
                          type: array
                          items:
                            type: string
                        logoUrl:
                          type: string
                          nullable: true
                          format: uri
                        externalId:
                          type: string
                          nullable: true
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                        columnValues:
                          type: object
                          additionalProperties:
                            type: string
                            nullable: true
                        documentsMissing:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                              label:
                                type: string
                            required:
                            - id
                            - label
                      required:
                      - id
                      - name
                      - description
                      - domainNames
                      - logoUrl
                      - externalId
                      - createdAt
                      - updatedAt
                      - columnValues
                      - documentsMissing
                required:
                - data
        '404':
          description: List not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Get lists by id companies
      x-summary-source: derived
      operationId: getListsByIdCompanies
      x-operation-id-source: derived
  /lists/{id}/chats:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      - schema:
          type: integer
          minimum: 1
          maximum: 100
        required: false
        name: limit
        in: query
      responses:
        '200':
          description: List onboarding list chats
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        title:
                          type: string
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                      - id
                      - title
                      - createdAt
                      - updatedAt
                required:
                - data
        '404':
          description: List not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Get lists by id chats
      x-summary-source: derived
      operationId: getListsByIdChats
      x-operation-id-source: derived
  /lists/{listId}/views:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: listId
        in: path
      responses:
        '200':
          description: List views for a list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        listId:
                          type: string
                          format: uuid
                        name:
                          type: string
                        filters:
                          type: object
                          additionalProperties:
                            nullable: true
                          default: {}
                        position:
                          type: string
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                      - id
                      - listId
                      - name
                      - position
                      - createdAt
                      - updatedAt
                required:
                - data
        '404':
          description: List not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Get lists by list id views
      x-summary-source: derived
      operationId: getListsByListIdViews
      x-operation-id-source: derived
    post:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: listId
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                filters:
                  type: object
                  additionalProperties:
                    nullable: true
                  default: {}
              required:
              - name
      responses:
        '201':
          description: List view created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      listId:
                        type: string
                        format: uuid
                      name:
                        type: string
                      filters:
                        type: object
                        additionalProperties:
                          nullable: true
                        default: {}
                      position:
                        type: string
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                    - id
                    - listId
                    - name
                    - position
                    - createdAt
                    - updatedAt
                required:
                - data
        '404':
          description: List not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Create lists by list id views
      x-summary-source: derived
      operationId: postListsByListIdViews
      x-operation-id-source: derived
  /lists/{listId}/views/{viewId}:
    patch:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: listId
        in: path
      - schema:
          type: string
          format: uuid
        required: true
        name: viewId
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                filters:
                  type: object
                  additionalProperties:
                    nullable: true
                  default: {}
      responses:
        '200':
          description: List view updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      listId:
                        type: string
                        format: uuid
                      name:
                        type: string
                      filters:
                        type: object
                        additionalProperties:
                          nullable: true
                        default: {}
                      position:
                        type: string
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                    - id
                    - listId
                    - name
                    - position
                    - createdAt
                    - updatedAt
                required:
                - data
        '404':
          description: List or view not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Update lists by list id views by view id
      x-summary-source: derived
      operationId: patchListsByListIdViewsByViewId
      x-operation-id-source: derived
    delete:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: listId
        in: path
      - schema:
          type: string
          format: uuid
        required: true
        name: viewId
        in: path
      responses:
        '204':
          description: List view deleted
        '404':
          description: List or view not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Lists
      summary: Delete lists by list id views by view id
      x-summary-source: derived
      operationId: deleteListsByListIdViewsByViewId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key