Chorus.ai

Chorus.ai Engagement filter API

The Engagement filter API from Chorus.ai — 3 operation(s) for engagement filter.

GitHub OpenAPI

Operations 6

GET /api/v1/filters Fetch all the customer's engagement_filter #
POST /api/v1/filters Create engagement filter #
POST /api/v1/filters/actions/replace Replace all engagement_filters #
DELETE /api/v1/filters/{id} Delete an engagement filter #
GET /api/v1/filters/{id} Fetch one engagement_filter #
PUT /api/v1/filters/{id} Update one engagement_filter #

Documentation

📖
Documentation
https://chorus.ai/api-docs/index.html
📖
APIReference
https://api-docs.chorus.ai/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/chorus-ai/refs/heads/main/authentication/chorus-ai-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/chorus-ai/refs/heads/main/openapi/chorus-ai-engagement-filter-api-openapi.yml

Other Resources

🔗
Postman
https://api-docs.chorus.ai/
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/chorus-ai/refs/heads/main/conventions/chorus-ai-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/chorus-ai/refs/heads/main/errors/chorus-ai-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/chorus-ai/refs/heads/main/data-model/chorus-ai-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/chorus-ai/refs/heads/main/asyncapi/chorus-ai-webhooks.yml

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/chorus-ai-engagement-filter-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

chorus-ai-engagement-filter-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The Chorus API is a REST API that enables you to retrieve information from and perform actions in Chorus.
  termsOfService: https://www.chorus.ai/terms
  title: Chorus Engagement filter API
  version: 26.33.08
servers:
- url: /
- url: https://chorus.ai
security:
- basic: []
- bearer-token: []
- x-ziaccesstoken: []
tags:
- name: Engagement filter
paths:
  /api/v1/filters:
    get:
      deprecated: false
      operationId: get-api-v1-filters
      parameters:
      - in: query
        name: filter[filter_name]
        required: false
        schema:
          type: string
      - in: query
        name: filter[filter_type]
        required: false
        schema:
          type: string
      - in: query
        name: filter[field_type]
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EngagementFiltersDoc'
          description: Success
        '400':
          $ref: '#/components/responses/BadRequest'
      summary: Fetch all the customer's engagement_filter
      tags:
      - Engagement filter
    post:
      deprecated: false
      description: This API is used to create new engagement filter.
      operationId: post-api-v1-filters
      parameters: []
      requestBody:
        content:
          application/vnd.api+json:
            example:
              data:
                attributes:
                  field_type: picklist
                  filter_name: test6
                  filter_type: TrustRadius
                  filter_values: '{"ZoomInfo SalesOS": "zi-sales", "Chorus": "chorus-ai"}'
                type: engagement_filter
            schema:
              $ref: '#/components/schemas/EngagementFilterForCreateDoc'
        required: true
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EngagementFilterDoc'
          description: Success
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
      summary: Create engagement filter
      tags:
      - Engagement filter
  /api/v1/filters/actions/replace:
    post:
      deprecated: false
      description: Replace all engagement_filters.
      operationId: post-api-v1-filters-actions-replace
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceAllEngagementFilters'
        required: true
      responses:
        '204':
          description: Success
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
      summary: Replace all engagement_filters
      tags:
      - Engagement filter
  /api/v1/filters/{id}:
    delete:
      deprecated: false
      description: Deletes an engagement filter permanently
      operationId: delete-api-v1-filters-id
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Success
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Delete an engagement filter
      tags:
      - Engagement filter
    get:
      deprecated: false
      description: Fetch one engagement_filter.
      operationId: get-api-v1-filters-id
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EngagementFilterDoc'
          description: Success
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Fetch one engagement_filter
      tags:
      - Engagement filter
    put:
      deprecated: false
      description: Update one engagement_filter.
      operationId: put-api-v1-filters-id
      parameters:
      - description: id
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/EngagementFilterEditDoc'
        required: true
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EngagementFilterEditDoc'
          description: Success
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      summary: Update one engagement_filter
      tags:
      - Engagement filter
components:
  schemas:
    EngagementFilterForCreate:
      properties:
        attributes:
          properties:
            field_type:
              type: string
            filter_name:
              type: string
            filter_type:
              type: string
            filter_values:
              default: 'null'
              type:
              - string
              - 'null'
          required:
          - filter_name
          - filter_type
          - field_type
          type: object
        type:
          description: The type of resource.
          enum:
          - engagement_filter
          example: engagement_filter
          title: Type
          type: string
      required:
      - attributes
      - type
      type: object
    Error:
      properties:
        errors:
          items:
            properties:
              code:
                type:
                - string
                - 'null'
              detail:
                type:
                - string
                - 'null'
              id:
                type:
                - string
                - 'null'
              source:
                properties:
                  cookie:
                    type:
                    - string
                    - 'null'
                  header:
                    type:
                    - string
                    - 'null'
                  parameter:
                    type:
                    - string
                    - 'null'
                  path:
                    type:
                    - string
                    - 'null'
                  pointer:
                    type:
                    - string
                    - 'null'
                type:
                - object
                - 'null'
              status:
                type:
                - string
                - 'null'
              title:
                type:
                - string
                - 'null'
            type: object
          type: array
      required:
      - errors
      type: object
    EngagementFilterDoc:
      properties:
        data:
          $ref: '#/components/schemas/EngagementFilter'
      required:
      - data
      type: object
    ReplaceAllEngagementFilters:
      properties:
        filter_type:
          type: string
        filters:
          items:
            properties:
              field_type:
                type: string
              filter_name:
                type: string
              filter_values:
                default: 'null'
                type:
                - string
                - 'null'
            required:
            - filter_name
            - field_type
            type: object
          type: array
        type:
          default: engagement_filter
          type: string
      required:
      - filter_type
      - filters
      - type
      type: object
    EngagementFilterForCreateDoc:
      properties:
        data:
          $ref: '#/components/schemas/EngagementFilterForCreate'
      required:
      - data
      type: object
    EngagementFilterEditDoc:
      properties:
        data:
          $ref: '#/components/schemas/EngagementFilterEdit'
      required:
      - data
      type: object
    EngagementFilterEdit:
      properties:
        attributes:
          properties:
            field_type:
              type:
              - string
              - 'null'
            filter_name:
              type:
              - string
              - 'null'
            filter_type:
              type:
              - string
              - 'null'
            filter_values:
              type:
              - string
              - 'null'
          type: object
        id:
          description: The unique ID of the engagement filter edit.
          example: '123'
          title: ID
          type: string
        type:
          description: The type of resource.
          enum:
          - engagement_filter_edit
          example: engagement_filter_edit
          title: Type
          type: string
      required:
      - attributes
      - type
      - id
      type: object
    EngagementFilter:
      properties:
        attributes:
          properties:
            field_type:
              type: string
            filter_name:
              type: string
            filter_type:
              type: string
            filter_values:
              default: 'null'
              type:
              - string
              - 'null'
          required:
          - filter_name
          - filter_type
          - field_type
          type: object
        id:
          description: The unique ID of the engagement filter.
          example: '123'
          title: ID
          type: string
        type:
          description: The type of resource.
          enum:
          - engagement_filter
          example: engagement_filter
          title: Type
          type: string
      required:
      - attributes
      - type
      - id
      type: object
    EngagementFiltersDoc:
      properties:
        data:
          items:
            $ref: '#/components/schemas/EngagementFilter'
          type: array
      required:
      - data
      type: object
  responses:
    BadRequest:
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Bad request
    NotFound:
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Not found
    Conflict:
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Conflict
  securitySchemes:
    basic:
      description: HTTP basic authentication (for those APIs that support it).
      scheme: basic
      type: http
    bearer-token:
      description: A Chorus token or a signed JWT.
      scheme: bearer
      type: http
    x-ziaccesstoken:
      description: A ZoomInfo access token.
      in: header
      name: x-ziaccesstoken
      type: apiKey