Khoros

Khoros Customer API

The Customer API from Khoros — 4 operation(s) for customer.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /customer/bestmatch Find the best-matching customer from social info · bestmatchCustomers #
Ask an LLM
“How do I match a social profile to an existing customer record?”
“Can I find a customer using their email, phone or order number?”
Tell an agent
Find the best customer match for screen name {screenName}.
Match a customer using email {email} and order numbers {orderNumbers}.
POST /customer Create a customer record · createCustomer #
Ask an LLM
“How do I add a new customer record in Khoros?”
“Can I set custom searchable fields when creating a customer?”
Tell an agent
Create a customer with searchable field one set to {customSearchableCustomerFieldOne}.
Add a new customer with non-searchable field one {customNonSearchableCustomerFieldOne}.
GET /customer/{id} Get a customer by ID · findCustomer #
Ask an LLM
“How do I pull up a specific customer's details?”
“What info is stored on a customer record?”
Tell an agent
Get customer {id}.
Show the profile details for customer {id}.
PATCH /customer/{id} Update a customer's details · updateCustomer #
Ask an LLM
“Can I change the custom fields on an existing customer?”
“How do I update a customer record I already created?”
Tell an agent
Update customer {id} searchable field two to {customSearchableCustomerFieldTwo}.
Patch customer {id} with non-searchable field two {customNonSearchableCustomerFieldTwo}.
GET /customer/{id}/cases List a customer's cases · findCases #
Ask an LLM
“Which support cases are linked to a customer?”
“How do I see the full case history for one customer?”
Tell an agent
List all cases for customer {id}.
Show the support cases opened by customer {id}.

Documentation

📖
Documentation
https://developer.khoros.com/khoroscaredevdocs/docs/khoros-care-integration-overview
📖
Documentation
https://developer.khoros.com/khorosmarketingdevdocs/docs/developing-and-integrating-with-khoros-marketing
📖
Documentation
https://developer.khoros.com/khoros-flow/docs/overview-of-khoros-flow-apis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/khoros-ai/refs/heads/main/openapi/khoros-ai-customer-api-openapi.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/khoros-ai:khoros-ai-customer-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

khoros-ai-customer-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Khoros Ai Customer API
  version: '1.1'
  description: 'Operations tagged Customer across 2 of this provider''s published API definitions: lithium-care-api-specifications-openapi.json, lithium-marketing-api-specifications-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{your-domain}.com
  variables:
    your-domain:
      default: your-domain
security:
- {}
tags:
- name: Customer
paths:
  /customer/bestmatch:
    post:
      summary: bestmatchCustomers
      description: Find a customer best match based on known Social Information
      operationId: bestmatchcustomers
      parameters:
      - name: x-sf-user-email
        in: header
        description: The email ID of the Khoros Care agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The ID of the active Khoros Care initiative the user is in when performing the action.
        schema:
          type: integer
          format: int32
      - name: x-sf-company-id
        in: header
        description: The Khoros Care ID of the company the user is in when making the request.
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  description: The name of the user as it would appear on the social network.
                screenName:
                  type: string
                  description: The social handle of the user.
                description:
                  type: string
                  description: A description of the user as specified in Khoros Care.
                profileUrl:
                  type: string
                  description: 'A direct link to the user''s social profile #header.'
                email:
                  type: string
                  description: An email address to the user.
                phoneNumbers:
                  type: array
                  description: A list of phone numbers for the user as defined in Khoros Care.
                  items:
                    type: string
                addresses:
                  type: array
                  description: A list of addresses for the user as defined in Khoros Care.
                  items:
                    properties:
                      streetOne:
                        type: string
                        description: First line of an address.
                      streetTwo:
                        type: string
                        description: Optional line two of an address.
                      city:
                        type: string
                        description: City of an address.
                      state:
                        type: string
                        description: State of an address.
                      zip:
                        type: string
                        description: Postal code of an address.
                    type: object
                orderNumbers:
                  type: array
                  description: A list of order numbers for the user as defined in Khoros Care.
                  items:
                    type: string
                caseNumbers:
                  type: array
                  description: A list of case numbers for the user as defined in Khoros Care. **Note:** These will not be case numbers from this system.
                  items:
                    type: string
                accountNumbers:
                  type: array
                  description: A list of account numbers for the user as defined in Khoros Care.
                  items:
                    type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
      deprecated: false
      tags:
      - Customer
    servers:
    - url: https://{your-domain}.com
      variables:
        your-domain:
          default: your-domain
  /customer:
    post:
      summary: createCustomer
      description: Create a new customer
      operationId: createcustomer
      parameters:
      - name: x-sf-user-email
        in: header
        description: The email id of the Khoros Care agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The id of the active Khoros Care Initiative the user is in when performing the action.
        schema:
          type: string
      - name: x-sf-company-id
        in: header
        description: The Khoros Care id of the company the user is in when making the request.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customNonSearchableCustomerFieldOne:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": false`.'
                customNonSearchableCustomerFieldTwo:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": false`.'
                customSearchableCustomerFieldOne:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": true`.'
                customSearchableCustomerFieldTwo:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": true`.'
      responses:
        '200':
          description: '200'
          content:
            text/plain:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
        '422':
          description: '422'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
      deprecated: false
      tags:
      - Customer
    servers:
    - url: https://{your-domain}.com
      variables:
        your-domain:
          default: your-domain
  /customer/{id}:
    get:
      summary: findCustomer
      description: Returns info for a specific customer
      operationId: findcustomer
      parameters:
      - name: id
        in: path
        description: Customer ID
        schema:
          type: string
        required: true
      - name: x-sf-user-email
        in: header
        description: The email ID of the Khoros Care agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The ID of the active Khoros Care initiative the user is in when performing the action. **Format:** int64
        schema:
          type: integer
          format: int32
      - name: x-sf-company-id
        in: header
        description: The Khoros Care ID of the company the user is in when making the request. **Format:** int64
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
        '404':
          description: '404'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
      deprecated: false
      security: []
      tags:
      - Customer
    patch:
      summary: updateCustomer
      description: Update a customer’s details
      operationId: updatecustomer
      parameters:
      - name: x-sf-user-email
        in: header
        description: The email id of the Khoros Marketing agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The id of the active Khoros Marketing Initiative the user is in when performing the action.
        schema:
          type: string
      - name: x-sf-company-id
        in: header
        description: The Khoros Marketing id of the company the user is in when making the request.
        schema:
          type: string
      - name: id
        in: path
        description: Customer ID
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customNonSearchableCustomerFieldOne:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": false`. These will only be present if specified via the [createCustomer](ref:createcustomer) endpoint.'
                customNonSearchableCustomerFieldTwo:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": false`. These will only be present if specified via the [createCustomer](ref:createcustomer) endpoint.'
                customSearchableCustomerFieldOne:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": true`. These will only be present if specified via the [createCustomer](ref:createcustomer) endpoint.'
                customSearchableCustomerFieldTwo:
                  type: string
                  description: 'An example of a custom field on the Customer object with `"searchable": true`. These will only be present if specified via the [createCustomer](ref:createcustomer) endpoint.'
      responses:
        '201':
          description: '201'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '422':
          description: '422'
          content:
            text/plain:
              examples:
                Result:
                  value: See Details for Schema
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
      deprecated: false
      security: []
      tags:
      - Customer
    servers:
    - url: https://{your-domain}.com
      variables:
        your-domain:
          default: your-domain
  /customer/{id}/cases:
    get:
      summary: findCases
      description: Get all cases for the given customer ID
      operationId: findcases
      parameters:
      - name: id
        in: path
        description: Customer ID
        schema:
          type: string
        required: true
      - name: x-sf-user-email
        in: header
        description: The email ID of the Khoros Care agent performing the action.
        schema:
          type: string
      - name: x-sf-initiative
        in: header
        description: The ID of the active Khoros Care initiative the user is in when performing the action. **Format:** int64
        schema:
          type: integer
          format: int32
      - name: x-sf-company-id
        in: header
        description: The Khoros Care ID of the company the user is in when making the request. **Format:** int64
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '401':
          description: '401'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
        '404':
          description: '404'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
        '500':
          description: '500'
          content:
            text/plain:
              examples:
                Result:
                  value: ''
      deprecated: false
      security: []
      tags:
      - Customer
    servers:
    - url: https://{your-domain}.com
      variables:
        your-domain:
          default: your-domain
x-refined-from:
- lithium-care-api-specifications-openapi.json
- lithium-marketing-api-specifications-openapi.json
x-readme:
  headers: []
  explorer-enabled: false
  proxy-enabled: true
x-readme-fauxas: true