Chatinbox

Chatinbox Customer API

The Customer API from Chatinbox — 12 operation(s) for customer.

GitHub OpenAPI

Operations 13

GET /api/customer/{id}/history Get api customer by id history #
GET /api/customer/history/by-date-range Get api customer history by date range #
GET /api/customer/{id}/selections Get api customer by id selections #
POST /api/customer/selections Create api customer selections #
GET /api/customers Get api customers #
POST /api/customers Create api customers #
GET /api/customers/{id} Get api customers by id #
POST /api/customersv3 Create api customersv3 #
POST /api/custom-field/customer-custom-field-update Create api custom field customer custom field update #
GET /api/v2/customer/{id}/detail Get api customer by id detail #
GET /api/v2/customer/{id}/conversations Get api customer by id conversations #
PUT /api/v2/customer/{id}/info Replace api customer by id info #
PUT /api/v2/customer/{id}/features Replace api customer by id features #

Documentation

📖
APIReference
https://api.chatinbox.net/swagger/index.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/chatinbox-net/openapi/chatinbox-net-customer-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/chatinbox-net/json-schema/chatinbox-net-customerv3-vm-schema.json
📊
JSONSchema
https://artifacts.apis.io/chatinbox-net/json-schema/chatinbox-net-customer-vm-schema.json
📊
JSONSchema
https://artifacts.apis.io/chatinbox-net/json-schema/chatinbox-net-customer-custom-field-vm-schema.json
📊
JSONSchema
https://artifacts.apis.io/chatinbox-net/json-schema/chatinbox-net-customer-selections-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/chatinbox-net/json-schema/chatinbox-net-update-customer-features-vm-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/chatinbox-net:chatinbox-net-customer-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

chatinbox-net-customer-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Chatinbox Net Customer API
  version: '1.0'
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Customer across 2 of this provider''s published API definitions: chatinbox-net-openapi-original.json, chatinbox-net-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.chatinbox.net
  description: Host serving the Swagger UI and this spec (spec has no servers[]; paths are relative to it)
security:
- Bearer: []
tags:
- name: Customer
paths:
  /api/customer/{id}/history:
    get:
      tags:
      - Customer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: beforeDate
        in: query
        schema:
          type: string
          format: date-time
      - name: beforeId
        in: query
        schema:
          type: integer
          format: int64
      - name: take
        in: query
        schema:
          type: integer
          format: int32
          default: 20
      - name: api-version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Get api customer by id history
      x-summary-source: derived
      operationId: getApiCustomerByIdHistory
      x-operation-id-source: derived
  /api/customer/history/by-date-range:
    get:
      tags:
      - Customer
      parameters:
      - name: startLocal
        in: query
        schema:
          type: string
          format: date-time
      - name: endLocal
        in: query
        schema:
          type: string
          format: date-time
      - name: entityType
        in: query
        schema:
          type: integer
          format: int32
      - name: beforeDate
        in: query
        schema:
          type: string
          format: date-time
      - name: beforeId
        in: query
        schema:
          type: integer
          format: int64
      - name: take
        in: query
        schema:
          type: integer
          format: int32
          default: 20
      - name: api-version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Get api customer history by date range
      x-summary-source: derived
      operationId: getApiCustomerHistoryByDateRange
      x-operation-id-source: derived
  /api/customer/{id}/selections:
    get:
      tags:
      - Customer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: api-version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Get api customer by id selections
      x-summary-source: derived
      operationId: getApiCustomerByIdSelections
      x-operation-id-source: derived
  /api/customer/selections:
    post:
      tags:
      - Customer
      parameters:
      - name: api-version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CustomerSelectionsRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerSelectionsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomerSelectionsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomerSelectionsRequest'
      responses:
        '200':
          description: Success
      summary: Create api customer selections
      x-summary-source: derived
      operationId: postApiCustomerSelections
      x-operation-id-source: derived
  /api/customers:
    get:
      tags:
      - Customer
      parameters:
      - name: api-version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Get api customers
      x-summary-source: derived
      operationId: getApiCustomers
      x-operation-id-source: derived
    post:
      tags:
      - Customer
      parameters:
      - name: api-version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CustomerVM'
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerVM'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomerVM'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomerVM'
      responses:
        '200':
          description: Success
      summary: Create api customers
      x-summary-source: derived
      operationId: postApiCustomers
      x-operation-id-source: derived
  /api/customers/{id}:
    get:
      tags:
      - Customer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: api-version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Get api customers by id
      x-summary-source: derived
      operationId: getApiCustomersById
      x-operation-id-source: derived
  /api/customersv3:
    post:
      tags:
      - Customer
      parameters:
      - name: api-version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Customerv3VM'
          application/json:
            schema:
              $ref: '#/components/schemas/Customerv3VM'
          text/json:
            schema:
              $ref: '#/components/schemas/Customerv3VM'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Customerv3VM'
      responses:
        '200':
          description: Success
      summary: Create api customersv3
      x-summary-source: derived
      operationId: postApiCustomersv3
      x-operation-id-source: derived
  /api/custom-field/customer-custom-field-update:
    post:
      tags:
      - Customer
      parameters:
      - name: api-version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CustomerCustomFieldVM'
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerCustomFieldVM'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomerCustomFieldVM'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomerCustomFieldVM'
      responses:
        '200':
          description: Success
      summary: Create api custom field customer custom field update
      x-summary-source: derived
      operationId: postApiCustomFieldCustomerCustomFieldUpdate
      x-operation-id-source: derived
  /api/v2/customer/{id}/detail:
    get:
      tags:
      - Customer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: api-version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Get api customer by id detail
      x-summary-source: derived
      operationId: getApiV2CustomerByIdDetail
      x-operation-id-source: derived
  /api/v2/customer/{id}/conversations:
    get:
      tags:
      - Customer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: api-version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
      summary: Get api customer by id conversations
      x-summary-source: derived
      operationId: getApiV2CustomerByIdConversations
      x-operation-id-source: derived
  /api/v2/customer/{id}/info:
    put:
      tags:
      - Customer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: api-version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              type: string
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
          application/*+json:
            schema:
              type: string
      responses:
        '200':
          description: Success
      summary: Replace api customer by id info
      x-summary-source: derived
      operationId: putApiV2CustomerByIdInfo
      x-operation-id-source: derived
  /api/v2/customer/{id}/features:
    put:
      tags:
      - Customer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: api-version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerFeaturesVM'
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerFeaturesVM'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerFeaturesVM'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerFeaturesVM'
      responses:
        '200':
          description: Success
      summary: Replace api customer by id features
      x-summary-source: derived
      operationId: putApiV2CustomerByIdFeatures
      x-operation-id-source: derived
components:
  schemas:
    CallReasonVM:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    CustomerTextValueVM:
      type: object
      properties:
        featureGroupID:
          type: integer
          format: int32
        featureGroupName:
          type:
          - string
          - 'null'
        textValue:
          type:
          - string
          - 'null'
      additionalProperties: false
    FeatureVM:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        featureType:
          type: integer
          format: int32
        rgbCode:
          type:
          - string
          - 'null'
        featureGroupID:
          type:
          - integer
          - 'null'
          format: int32
        dataStatus:
          type: integer
          format: int32
        activeSelectionCount:
          type: integer
          format: int32
        flagMinutes:
          type:
          - integer
          - 'null'
          format: int32
        sortOrder:
          type: integer
          format: int32
      additionalProperties: false
    CustomerPhoneVM:
      type: object
      properties:
        id:
          type: integer
          format: int32
        customerID:
          type: integer
          format: int32
        phone:
          type:
          - string
          - 'null'
      additionalProperties: false
    Customerv3VM:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        dataListID:
          type: integer
          format: int32
        pushName:
          type:
          - string
          - 'null'
        note:
          type:
          - string
          - 'null'
        features:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FeatureVM'
        phoneNumber:
          type:
          - string
          - 'null'
        phoneNumbers:
          type:
          - array
          - 'null'
          items:
            type: string
        phoneNumberEnc:
          type:
          - string
          - 'null'
        phoneNumbersEnc:
          type:
          - array
          - 'null'
          items:
            type: string
        email:
          type:
          - string
          - 'null'
        chatID:
          type: integer
          format: int32
        cf1:
          type:
          - string
          - 'null'
        cf2:
          type:
          - string
          - 'null'
        cf3:
          type:
          - string
          - 'null'
        cf4:
          type:
          - string
          - 'null'
        cf5:
          type:
          - string
          - 'null'
        cf6:
          type:
          - string
          - 'null'
        cf7:
          type:
          - string
          - 'null'
        cf8:
          type:
          - string
          - 'null'
        cf9:
          type:
          - string
          - 'null'
        cf10:
          type:
          - string
          - 'null'
        callMeLaters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CallMeLaterVM'
        notCompletedCallMeLaters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CallMeLaterVM'
        isCompletedCallMeLaters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CallMeLaterVM'
        customerAccountID:
          type:
          - string
          - 'null'
        notes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NoteVM'
        chats:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerChatVM'
        selections:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerSelectedFeatureVM'
        textValues:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerTextValueVM'
      additionalProperties: false
    CallMeLaterVM:
      type: object
      properties:
        id:
          type: integer
          format: int32
        customerID:
          type: integer
          format: int32
        chatID:
          type:
          - integer
          - 'null'
          format: int32
        callReasonID:
          type:
          - integer
          - 'null'
          format: int32
        callReasonName:
          type:
          - string
          - 'null'
        note:
          type:
          - string
          - 'null'
        relatedUserID:
          type: integer
          format: int32
        relatedUserName:
          type:
          - string
          - 'null'
        relatedUserFullName:
          type:
          - string
          - 'null'
        relatedTime:
          type:
          - string
          - 'null'
          format: date-time
        workGroupID:
          type:
          - integer
          - 'null'
          format: int32
        isCompleted:
          type: boolean
        completedUserID:
          type:
          - integer
          - 'null'
          format: int32
        completedUserName:
          type:
          - string
          - 'null'
        completedUserFullName:
          type:
          - string
          - 'null'
        completedTime:
          type:
          - string
          - 'null'
          format: date-time
        createDate:
          type:
          - string
          - 'null'
          format: date-time
        customerFullName:
          type:
          - string
          - 'null'
        callReason:
          $ref: '#/components/schemas/CallReasonVM'
        allCallReasons:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CallReasonVM'
      additionalProperties: false
    CustomerSelectionsRequest:
      type: object
      properties:
        customerId:
          type: integer
          format: int32
        featureGroupId:
          type: integer
          format: int32
        featureIds:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        textValue:
          type:
          - string
          - 'null'
        companyId:
          type:
          - integer
          - 'null'
          format: int32
        clientRequestId:
          type:
          - string
          - 'null'
      additionalProperties: false
    CustomerCustomFieldVM:
      type: object
      properties:
        customerId:
          type: integer
          format: int32
        cf1:
          type:
          - string
          - 'null'
        cf2:
          type:
          - string
          - 'null'
        cf3:
          type:
          - string
          - 'null'
        cf4:
          type:
          - string
          - 'null'
        cf5:
          type:
          - string
          - 'null'
        cf6:
          type:
          - string
          - 'null'
        cf7:
          type:
          - string
          - 'null'
        cf8:
          type:
          - string
          - 'null'
        cf9:
          type:
          - string
          - 'null'
        cf10:
          type:
          - string
          - 'null'
      additionalProperties: false
    UpdateCustomerFeaturesVM:
      type: object
      properties:
        featureIds:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
      additionalProperties: false
    NoteVM:
      type: object
      properties:
        id:
          type: integer
          format: int32
        chatID:
          type: integer
          format: int32
        noteContent:
          type:
          - string
          - 'null'
        creatingUserID:
          type: integer
          format: int32
        creatingUserName:
          type:
          - string
          - 'null'
        customerID:
          type: integer
          format: int32
        createDate:
          type: string
          format: date-time
        isSystemNote:
          type: boolean
      additionalProperties: false
    CustomerVM:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        surName:
          type:
          - string
          - 'null'
        pushName:
          type:
          - string
          - 'null'
        fullName:
          type:
          - string
          - 'null'
        note:
          type:
          - string
          - 'null'
        lastMessageID:
          type:
          - integer
          - 'null'
          format: int32
        email:
          type:
          - string
          - 'null'
        chatId:
          type: integer
          format: int32
        customerPhones:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerPhoneVM'
        customerFeatures:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FeatureVM'
        callMeLaters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CallMeLaterVM'
        cf1:
          type:
          - string
          - 'null'
        cf2:
          type:
          - string
          - 'null'
        cf3:
          type:
          - string
          - 'null'
        cf4:
          type:
          - string
          - 'null'
        cf5:
          type:
          - string
          - 'null'
        cf6:
          type:
          - string
          - 'null'
        cf7:
          type:
          - string
          - 'null'
        cf8:
          type:
          - string
          - 'null'
        cf9:
          type:
          - string
          - 'null'
        cf10:
          type:
          - string
          - 'null'
        dataListID:
          type: integer
          format: int32
      additionalProperties: false
    CustomerSelectedFeatureVM:
      type: object
      properties:
        featureID:
          type: integer
          format: int32
        featureName:
          type:
          - string
          - 'null'
        rgbCode:
          type:
          - string
          - 'null'
        featureGroupID:
          type: integer
          format: int32
        featureGroupName:
          type:
          - string
          - 'null'
        flagMinutes:
          type:
          - integer
          - 'null'
          format: int32
        minutesSinceSelected:
          type: integer
          format: int32
        sortOrder:
          type: integer
          format: int32
      additionalProperties: false
    CustomerChatVM:
      type: object
      properties:
        id:
          type: integer
          format: int32
        channelID:
          type: integer
          format: int32
        customerPhoneNumber:
          type:
          - string
          - 'null'
        customerPhoneNumberEnc:
          type:
          - string
          - 'null'
        customerAccountID:
          type:
          - string
          - 'null'
        instanceType:
          type: integer
          format: int32
        ownerUserID:
          type: integer
          format: int32
        visible:
          type: boolean
        manageable:
          type: boolean
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: 'JWT Authorization header. Örnek: "Bearer {token}"'
      name: Authorization
      in: header
x-refined-from:
- chatinbox-net-openapi-original.json
- chatinbox-net-openapi.yml