Rulebase

Rulebase Pinned Conversations API

The Pinned Conversations API from Rulebase — 2 operation(s) for pinned conversations.

GitHub OpenAPI

Operations 3

POST /pinned-conversations Create pinned conversations #
GET /pinned-conversations Get pinned conversations #
DELETE /pinned-conversations/{id} Delete pinned conversations by id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-pinned-conversations-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-pinned-conversations-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-pinned-conversations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Pinned Conversations API
  version: 0.0.1
tags:
- name: Pinned Conversations
paths:
  /pinned-conversations:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pinned_conversation:
                  type: object
                  properties:
                    employee_id:
                      type: string
                    conversation_id:
                      type: string
                  required:
                  - employee_id
                  - conversation_id
              required:
              - pinned_conversation
      responses:
        '201':
          description: Pinned conversation created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      conversation:
                        type: object
                        properties:
                          id:
                            type: string
                          external_id:
                            type: string
                            nullable: true
                          subject:
                            type: string
                        required:
                        - id
                        - external_id
                        - subject
                      employee:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                            nullable: true
                          avatar_url:
                            type: string
                            nullable: true
                        required:
                        - id
                        - name
                        - avatar_url
                      created_by:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                          full_name:
                            type: string
                          email:
                            type: string
                        required:
                        - id
                        - full_name
                        - email
                    required:
                    - id
                    - created_at
                    - updated_at
                    - conversation
                    - employee
                    - created_by
                required:
                - data
        '404':
          description: Employee or conversation not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '422':
          description: Conversation already pinned for this employee
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Pinned Conversations
      summary: Create pinned conversations
      x-summary-source: derived
      operationId: postPinnedConversations
      x-operation-id-source: derived
    get:
      parameters:
      - schema:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          default: 1
        required: false
        name: page
        in: query
      - schema:
          type: integer
          description: Values above 100 are clamped to 100
          minimum: 1
        required: false
        name: limit
        in: query
      - schema:
          type: string
        required: true
        name: employee_id
        in: query
      responses:
        '200':
          description: List an agent's pinned conversations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        conversation:
                          type: object
                          properties:
                            id:
                              type: string
                            external_id:
                              type: string
                              nullable: true
                            subject:
                              type: string
                          required:
                          - id
                          - external_id
                          - subject
                        employee:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                              nullable: true
                            avatar_url:
                              type: string
                              nullable: true
                          required:
                          - id
                          - name
                          - avatar_url
                        created_by:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                            full_name:
                              type: string
                            email:
                              type: string
                          required:
                          - id
                          - full_name
                          - email
                      required:
                      - id
                      - created_at
                      - updated_at
                      - conversation
                      - employee
                      - created_by
                  meta:
                    type: object
                    properties:
                      page:
                        type: object
                        properties:
                          next:
                            type: string
                            nullable: true
                          limit:
                            type: integer
                          total:
                            type: integer
                        required:
                        - next
                        - limit
                        - total
                    required:
                    - page
                required:
                - data
                - meta
        '404':
          description: Agent not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Pinned Conversations
      summary: Get pinned conversations
      x-summary-source: derived
      operationId: getPinnedConversations
      x-operation-id-source: derived
  /pinned-conversations/{id}:
    delete:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Pinned conversation deleted
        '403':
          description: Pin was created by another member
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Pinned Conversations
      summary: Delete pinned conversations by id
      x-summary-source: derived
      operationId: deletePinnedConversationsById
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key