Rulebase

Rulebase Customer Fields API

The Customer Fields API from Rulebase — 2 operation(s) for customer fields.

GitHub OpenAPI

Operations 4

GET /customer-fields Get customer fields #
POST /customer-fields Create customer fields #
PATCH /customer-fields/{id} Update customer fields by id #
DELETE /customer-fields/{id} Delete customer fields by id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-customer-fields-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-customer-fields-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-customer-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Customer Fields API
  version: 0.0.1
tags:
- name: Customer Fields
paths:
  /customer-fields:
    get:
      parameters:
      - schema:
          type: string
        required: false
        name: query
        in: query
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
        required: false
        name: owned
        in: query
      - 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
      responses:
        '200':
          description: List customer field definitions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        name:
                          type: string
                          nullable: true
                        external_id:
                          type: string
                          nullable: true
                        options:
                          type: object
                          nullable: true
                          properties: {}
                        organization_data_source_id:
                          type: string
                          nullable: true
                        editable:
                          type: boolean
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        value_type:
                          type: string
                          nullable: true
                          enum:
                          - string
                          - boolean
                          - date
                          - datetime
                          - number
                          - enum
                      required:
                      - id
                      - label
                      - name
                      - external_id
                      - options
                      - organization_data_source_id
                      - editable
                      - created_at
                      - updated_at
                      - value_type
                  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
        '503':
          description: Rails organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Customer Fields
      summary: Get customer fields
      x-summary-source: derived
      operationId: getCustomerFields
      x-operation-id-source: derived
    post:
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_field:
                  type: object
                  properties:
                    label:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
                    name:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
                    value_type:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
                    options:
                      type: object
                      nullable: true
                      properties:
                        type:
                          anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                          - nullable: true
                        record_type:
                          anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                          - nullable: true
                        values:
                          type: array
                          nullable: true
                          items:
                            anyOf:
                            - type: string
                            - type: number
                            - type: boolean
                            - nullable: true
                        labels:
                          type: array
                          nullable: true
                          items:
                            anyOf:
                            - type: string
                            - type: number
                            - type: boolean
                            - nullable: true
                    description:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
                    display_format:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
      responses:
        '201':
          description: Create a customer field definition
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      label:
                        type: string
                      name:
                        type: string
                        nullable: true
                      external_id:
                        type: string
                        nullable: true
                      options:
                        type: object
                        nullable: true
                        properties: {}
                      organization_data_source_id:
                        type: string
                        nullable: true
                      editable:
                        type: boolean
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      value_type:
                        type: string
                        nullable: true
                      organization_data_source:
                        nullable: true
                      description:
                        type: string
                        nullable: true
                      display_format:
                        type: string
                        nullable: true
                      kind:
                        type: string
                    required:
                    - id
                    - label
                    - name
                    - external_id
                    - options
                    - organization_data_source_id
                    - editable
                    - created_at
                    - updated_at
                    - value_type
                    - organization_data_source
                required:
                - data
        '400':
          description: Missing wrapper or validation errors
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
                - type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
        '403':
          description: Provider-synced fields are read-only
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        code:
                          type: string
                        detail:
                          type: string
                      required:
                      - status
                      - title
                      - code
                      - detail
                required:
                - errors
        '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:
      - Customer Fields
      summary: Create customer fields
      x-summary-source: derived
      operationId: postCustomerFields
      x-operation-id-source: derived
  /customer-fields/{id}:
    patch:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_field:
                  type: object
                  properties:
                    label:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
                    name:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
                    value_type:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
                    options:
                      type: object
                      nullable: true
                      properties:
                        type:
                          anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                          - nullable: true
                        record_type:
                          anyOf:
                          - type: string
                          - type: number
                          - type: boolean
                          - nullable: true
                        values:
                          type: array
                          nullable: true
                          items:
                            anyOf:
                            - type: string
                            - type: number
                            - type: boolean
                            - nullable: true
                        labels:
                          type: array
                          nullable: true
                          items:
                            anyOf:
                            - type: string
                            - type: number
                            - type: boolean
                            - nullable: true
                    description:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
                    display_format:
                      anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - nullable: true
      responses:
        '200':
          description: Update a customer field definition
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      label:
                        type: string
                      name:
                        type: string
                        nullable: true
                      external_id:
                        type: string
                        nullable: true
                      options:
                        type: object
                        nullable: true
                        properties: {}
                      organization_data_source_id:
                        type: string
                        nullable: true
                      editable:
                        type: boolean
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      value_type:
                        type: string
                        nullable: true
                      organization_data_source:
                        nullable: true
                      description:
                        type: string
                        nullable: true
                      display_format:
                        type: string
                        nullable: true
                      kind:
                        type: string
                    required:
                    - id
                    - label
                    - name
                    - external_id
                    - options
                    - organization_data_source_id
                    - editable
                    - created_at
                    - updated_at
                    - value_type
                    - organization_data_source
                required:
                - data
        '400':
          description: Missing wrapper or validation errors
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
                - type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
        '403':
          description: Provider-synced fields are read-only
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        code:
                          type: string
                        detail:
                          type: string
                      required:
                      - status
                      - title
                      - code
                      - detail
                required:
                - errors
        '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:
      - Customer Fields
      summary: Update customer fields by id
      x-summary-source: derived
      operationId: patchCustomerFieldsById
      x-operation-id-source: derived
    delete:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Delete a customer field definition
        '400':
          description: Missing wrapper or validation errors
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
                - type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
        '403':
          description: Provider-synced fields are read-only
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        code:
                          type: string
                        detail:
                          type: string
                      required:
                      - status
                      - title
                      - code
                      - detail
                required:
                - errors
        '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:
      - Customer Fields
      summary: Delete customer fields by id
      x-summary-source: derived
      operationId: deleteCustomerFieldsById
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key