Skip to content

Instantly share code, notes, and snippets.

@antonydevanchi

antonydevanchi/chatwoot.yaml

Last active July 21, 2025 21:42
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save antonydevanchi/4398fe3521a24785e38150df1fd0565a to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save antonydevanchi/4398fe3521a24785e38150df1fd0565a to your computer and use it in GitHub Desktop.
Download ZIP
chatwoot
Raw
chatwoot.yaml
openapi: 3.0.0
info:
title: Chatwoot Application API v1.0
version: 1.0.0
description: "- create appropriate environments and populate the environment variables"
servers:
- url: "https://support.parsecvpn.online"
- url: "{{host}}"
paths:
/auth/sign_in:
parameters: []
post:
summary: Sign In
parameters:
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api:
parameters: []
get:
summary: Get Installation details
parameters:
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/profile:
parameters: []
get:
summary: Get Profile
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
responses: {}
put:
summary: Update Profile
parameters:
- name: api_access_token
in: header
required: false
example: X8VfsMmLUPm4xgNjsLBTSK34
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
profile:
type: object
properties:
availability:
type: string
/api/v1/profile/set_active_account:
parameters: []
put:
summary: Set active account
parameters:
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
profile:
type: object
properties:
account_id:
type: integer
/api/v1/accounts/1/agent_bots:
parameters: []
get:
summary: List all AgentBots
parameters: []
responses: {}
post:
summary: Create an Agent Bot
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
/api/v1/accounts/1/canned_responses:
parameters: []
get:
summary: List Canned Responses
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/help_center_articles:
parameters: []
get:
summary: List all Articles
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/audit_logs:
parameters: []
get:
summary: List all logs
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/csat_survey_responses:
parameters: []
get:
summary: List CSAT Survey Responses
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/csat_survey_responses/download:
parameters: []
get:
summary: List CSAT Survey Responses Copy
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/public/api/v1/csat_survey/98c5d7f3-8873-4262-b101-d56425ff7ee1:
parameters: []
put:
summary: Update survey response
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
submitted_values:
type: object
properties:
csat_survey_response:
type: object
properties:
rating:
type: integer
get:
summary: Get survey response
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
submitted_values:
type: object
properties:
csat_survey_response:
type: object
properties:
rating:
type: integer
feedback_message:
type: string
/api/v1/accounts/1/campaigns:
parameters: []
post:
summary: Create Campaign
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
title:
type: string
message:
type: string
inbox_id:
type: integer
sender_id:
type: integer
get:
summary: List Campaigns
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/campaigns/{{campaign_id}}:
parameters: []
patch:
summary: Edit Campaign
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
get:
summary: Show Campaign
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
delete:
summary: Delete campaign
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/widget/campaigns:
parameters: []
get:
summary: Get Inbox Campaigns
parameters:
- name: website_token
in: query
required: false
example: "{{website_token}}"
schema:
type: string
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/sla_policies:
parameters: []
get:
summary: List SLAs
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
post:
summary: Create SLA
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
frt_threshold:
type: integer
rt_threshold:
type: integer
only_during_business_hours:
type: boolean
/api/v1/accounts/1/sla_policies/1:
parameters: []
patch:
summary: Update SLA
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
frt_threshold:
type: integer
rt_threshold:
type: integer
only_during_business_hours:
type: boolean
get:
summary: Show SLA
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
delete:
summary: Delete SLA
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/portals:
parameters: []
post:
summary: Create new Portal
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
portal:
type: object
properties:
name:
type: string
slug:
type: string
custom_domain:
type: string
color:
type: string
format: color
homepage_link:
type: string
page_title:
type: string
header_text:
type: string
config:
type: object
properties:
allowed_locales:
type: array
items:
type: string
get:
summary: Get All Portals
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/portals/{{portal_slug}}:
parameters: []
put:
summary: Update Portal
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
config:
type: object
properties:
default_locale:
type: string
allowed_locales:
type: array
items:
type: string
get:
summary: Get Portal Details
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
delete:
summary: Delete Portal
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
config:
type: object
properties:
allowed_locales:
type: array
items:
type: string
/api/v1/accounts/1/portals/{{portal_slug}}/articles:
parameters: []
get:
summary: Get Articles
parameters:
- name: page
in: query
required: false
example: "1"
schema:
type: integer
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
post:
summary: Create new article
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
/api/v1/accounts/1/portals/{{portal_slug}}/articles/21:
parameters: []
get:
summary: Get Article details
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/portals/{{portal_slug}}/folders:
parameters: []
post:
summary: Create new folder
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
account_id:
type: integer
category_id:
type: integer
/api/v1/accounts/1/portals/{{portal_slug}}/articles/28:
parameters: []
put:
summary: Update Article
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
/api/v1/accounts/1/portals/{{portal_slug}}/categories:
parameters: []
get:
summary: Get All Categories
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
description:
type: string
locale:
type: string
name:
type: string
position:
type: string
account_id:
type: integer
portal_id:
type: string
slug:
type: string
post:
summary: Create new Category
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
description:
type: string
locale:
type: string
name:
type: string
position:
type: string
account_id:
type: integer
slug:
type: string
/api/v1/accounts/1/portals/{{portal_slug}}/categories/23:
parameters: []
patch:
summary: Update category
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
category:
type: object
properties:
name:
type: string
description:
type: string
position:
type: integer
locale:
type: string
slug:
type: string
parent_category_id:
type: integer
linked_category_ids:
type: array
items:
type: integer
/api/v1/accounts/1/portals/{{portal_slug}}/categories/26:
parameters: []
delete:
summary: Delete Category
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
config:
type: object
properties:
allowed_locales:
type: array
items:
type: string
/api/v1/accounts/1/portals/{{portal_slug}}/articles/48:
parameters: []
delete:
summary: Delete Article
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
config:
type: object
properties:
allowed_locales:
type: array
items:
type: string
/api/v1/accounts/1/webhooks:
parameters: []
post:
summary: Create Webhook
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
webhook:
type: object
properties:
url:
type: string
format: uri
subscriptions:
type: array
items:
type: string
get:
summary: Get weboohks
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
webhook:
type: object
properties:
url:
type: string
format: uri
subscriptions:
type: array
items:
type: string
/api/v1/accounts/1/automation_rules:
parameters: []
post:
summary: Create Automation Rule
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
get:
summary: Get Automation Rules
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description:
type: string
event_name:
type: string
conditions:
type: array
items:
type: object
properties:
attribute_key:
type: string
filter_operator:
type: string
values:
type: array
items:
type: string
query_operator:
type: string
actions:
type: array
items:
type: object
properties:
action_name:
type: string
action_params:
type: array
items:
type: string
/api/v1/accounts/1/custom_attribute_definitions:
parameters: []
get:
summary: List Custom Attributes
parameters:
- name: attribute_model
in: query
required: false
example: "0"
schema:
type: integer
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
post:
summary: Create Custom Attribute
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
/api/v1/accounts/1/custom_attribute_definitions/{{custom_attribute_id}}:
parameters: []
put:
summary: Update Custom Attribute
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
attribute_description:
type: string
attribute_model:
type: integer
get:
summary: Show Custom Attribute
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
delete:
summary: Delete Custom Attribute
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/conversations:
parameters: []
get:
summary: List all conversations
parameters:
- name: status
in: query
required: false
example: open
schema:
type: string
- name: assignee_type_id
in: query
required: false
example: "0"
schema:
type: integer
- name: sort_order
in: query
required: false
example: latest_first
schema:
type: string
- name: assignee_type
in: query
required: false
example: all
schema:
type: string
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
post:
summary: Create Conversation
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
source_id:
type: string
/api/v1/accounts/1/conversations/{{conversation_id}}:
parameters: []
get:
summary: Get Conversation
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/conversations/{{conversation_id}}/messages:
parameters: []
get:
summary: Get messages
parameters:
- name: after
in: query
required: false
example: "189"
schema:
type: integer
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
post:
summary: Send message Attachments
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: multipart/form-data; boundary=----WebKitFormBoundary
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/conversations/{{conversation_id}}/attachments:
parameters: []
get:
summary: Get Attachments
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/conversations/meta:
parameters: []
get:
summary: Get Conversation meta
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/conversations/{{conversation_id}}/labels:
parameters: []
post:
summary: Add labels to conversation
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
labels:
type: array
items:
type: string
/api/v1/accounts/1/conversations/{{conversation_id}}/toggle_status:
parameters: []
post:
summary: Toggle conversation status
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
status:
type: string
snoozed_until:
nullable: true
/api/v1/accounts/1/conversations/{{conversation_id}}/custom_attributes:
parameters: []
post:
summary: Add custom attributes
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
custom_attributes:
type: object
properties:
product_name:
type: string
product_id:
type: integer
product_url:
type: string
format: uri
launch_date:
type: string
/api/v1/accounts/1/conversations/2/messages:
parameters: []
post:
summary: Send Interactive Message
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
content:
type: string
message_type:
type: string
/api/v1/accounts/1/conversations/filter:
parameters: []
post:
summary: Conversation Filter
parameters: []
responses: {}
/api/v1/accounts/1/bulk_actions:
parameters: []
post:
summary: Bulk actions
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
ids:
type: array
items:
type: integer
fields:
type: object
properties:
status:
type: string
snoozed_until:
type: string
format: utc-millisec
/api/v1/accounts/1/conversations/{{conversation_id}}/toggle_typing:
parameters: []
post:
summary: Toggle Typing
parameters:
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/conversations/{{conversation_id}}/toggle_priority:
parameters: []
post:
summary: Toggle Priority
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
priority:
type: string
/api/v1/accounts/1/upload:
parameters: []
post:
summary: Upload photos
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
external_url:
type: string
format: uri
/api/v1/notification_subscriptions:
parameters: []
post:
summary: Save device details
parameters:
- name: api_access_token
in: header
required: false
example: X8VfsMmLUPm4xgNjsLBTSK34
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
delete:
summary: Delete notification subscription
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
push_token:
type: string
format: uri
/api/v1/accounts/1/notifications:
parameters: []
get:
summary: List all notifications
parameters:
- name: includes[]
in: query
required: false
example: snoozed
schema:
type: string
- name: status
in: query
required: false
example: snoozed
schema:
type: string
- name: type
in: query
required: false
example: read
schema:
type: string
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/notifications/446:
parameters: []
delete:
summary: Delete notification
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/notifications/451/snooze:
parameters: []
post:
summary: Snooze notification
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
snoozed_until:
type: integer
/api/v1/accounts/1/notifications/366/unread:
parameters: []
post:
summary: Mark notificaiton as unread
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
/api/v1/accounts/1/inboxes:
parameters: []
get:
summary: List all inboxes
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/inbox_members/{{inbox_id}}:
parameters: []
get:
summary: Get Inbox Members
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/inboxes/{{inbox_id}}/verify_installation:
parameters: []
get:
summary: Inbox is installed or not
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/inboxes/{{inbox_id}}:
parameters: []
patch:
summary: Update inbox
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
/api/v1/accounts/1/inboxes/{{inbox_id}}/campaigns:
parameters: []
get:
summary: Get Inbox Campaigns
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/contacts/{{contact_id}}/contact_inboxes:
parameters: []
post:
summary: Create
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
inbox_id:
type: integer
source_id:
type: string
format: utc-millisec
/api/v1/accounts/1/contacts/{{contact_id}}/notes:
parameters: []
get:
summary: List Notes
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
post:
summary: Create Note
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
content:
type: string
/api/v1/accounts/1/contacts:
parameters: []
get:
summary: List Contacts
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
post:
summary: Create
parameters: []
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
inbox_id:
type: integer
source_id:
type: string
format: utc-millisec
phone_number:
type: string
format: utc-millisec
custom_attributes:
type: object
properties:
hello:
type: string
test:
type: string
/api/v1/accounts/1/contacts/{{contact_id}}:
parameters: []
get:
summary: Get Contact
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
patch:
summary: Update Contact
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
inbox_id:
type: integer
custom_attributes:
type: object
properties:
created_date:
type: string
/api/v1/accounts/1/contacts/{{contact_id}}/contactable_inboxes:
parameters: []
get:
summary: Get Contact Contactable Inboxes
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/contacts/{{contact_id}}/conversations:
parameters: []
get:
summary: Get Contact Conversataions
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/contacts/search:
parameters: []
get:
summary: Search
parameters:
- name: q
in: query
required: false
example: test
schema:
type: string
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/contacts/import:
parameters: []
post:
summary: import
parameters: []
responses: {}
/api/v1/accounts/1/agents:
parameters: []
get:
summary: List all agents
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/agents/{{agent_id}}:
parameters: []
patch:
summary: Update an Agent
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
availability:
type: string
/{{api_version_2}}/accounts/1/reports/account_summary:
parameters: []
get:
summary: Account Summary
parameters:
- name: since
in: query
required: false
example: "1603823400"
schema:
type: integer
- name: until
in: query
required: false
example: "1604341800"
schema:
type: integer
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/{{api_version_2}}/accounts/1/reports/agents:
parameters: []
get:
summary: Agents
parameters:
- name: since
in: query
required: false
example: "1603823400"
schema:
type: integer
- name: until
in: query
required: false
example: "1604341800"
schema:
type: integer
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/{{api_version_2}}/accounts/1/reports/account:
parameters: []
get:
summary: Reports
parameters:
- name: metric
in: query
required: false
example: conversations_count
schema:
type: string
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/{{api_version_2}}/accounts/1/reports/bot_metrics:
parameters: []
get:
summary: Bot metrics
parameters:
- name: since
in: query
required: false
example: "1710268200"
schema:
type: integer
- name: until
in: query
required: false
example: "1710872999"
schema:
type: integer
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/csat_survey_responses/metrics:
parameters: []
get:
summary: CSAT metrics
parameters:
- name: since
in: query
required: false
example: "1710268200"
schema:
type: integer
- name: until
in: query
required: false
example: "1710872999"
schema:
type: integer
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/applied_slas/metrics:
parameters: []
get:
summary: SLA metrics
parameters:
- name: since
in: query
required: false
example: "1710268200"
schema:
type: integer
- name: until
in: query
required: false
example: "1710872999"
schema:
type: integer
- name: label_list
in: query
required: false
example: delivery
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/applied_slas:
parameters: []
get:
summary: Get all SLAs
parameters:
- name: since
in: query
required: false
example: "1710095400"
schema:
type: integer
- name: until
in: query
required: false
example: "1712687399"
schema:
type: integer
- name: page
in: query
required: false
example: "1"
schema:
type: integer
- name: inbox_id
in: query
required: false
example: "2"
schema:
type: integer
- name: team_id
in: query
required: false
example: "1"
schema:
type: integer
- name: sla_policy_id
in: query
required: false
example: "1"
schema:
type: integer
- name: label_list
in: query
required: false
example: sla
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/applied_slas/download:
parameters: []
get:
summary: Download SLA report
parameters:
- name: since
in: query
required: false
example: "1712601000"
schema:
type: integer
- name: until
in: query
required: false
example: "1713205799"
schema:
type: integer
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/apps:
parameters: []
get:
summary: Get Integration Apps
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/files-pri/T7NN675QT-F05NCK8NRFT/66.jpg:
parameters: []
get:
summary: Get slack attachment
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/hooks:
parameters: []
post:
summary: Create Integration Hook
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
app_id:
type: string
inbox_id:
type: string
format: utc-millisec
settings:
type: object
properties:
project_id:
type: string
credentials:
type: object
properties:
test:
type: string
/api/v1/accounts/1/integrations/hooks/532:
parameters: []
delete:
summary: Delete Integration Hook
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
app_id:
type: string
inbox_id:
type: string
format: utc-millisec
settings:
type: object
properties:
project_id:
type: string
format: utc-millisec
credentials:
type: object
properties:
test:
type: string
/api/v1/widget/messages/1130842:
parameters: []
patch:
summary: Create CSAT
parameters:
- name: website_token
in: query
required: false
example: 4cWzuf9i9jxN9tbnv8K9STKU
schema:
type: integer
- name: cw_conversation
in: query
required: false
example: "{{cw_conversation_identifier}}"
schema:
type: string
- name: locale
in: query
required: false
example: en
schema:
type: string
- name: X-Auth-Token
in: header
required: false
example: "{{x-auth-token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
submitted_values:
type: object
properties:
csat_survey_response:
type: object
properties:
rating:
type: integer
feedback:
type: string
/api/v1/widget/contact:
parameters: []
put:
summary: Update Contact
parameters:
- name: website_token
in: query
required: false
example: 4cWzuf9i9jxN9tbnv8K9STKU
schema:
type: integer
- name: X-Auth-Token
in: header
required: false
example: "{{x-auth-token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
additional_attributes:
type: object
properties:
country_code:
type: string
city:
type: string
company_name:
type: string
description:
type: string
social_profiles:
type: object
properties:
linkedin:
type: string
twitter:
type: string
instagram:
type: string
/api/v1/accounts/1:
parameters: []
get:
summary: Get account details
parameters:
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/conversations/1/participants:
parameters: []
get:
summary: Get all participants
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
content:
type: string
message_type:
type: string
post:
summary: add participant
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
user_ids:
type: array
items:
type: integer
delete:
summary: delete participant
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
user_ids:
type: array
items:
type: integer
/api/v1/accounts/1/response_sources:
parameters: []
post:
summary: Response sources
parameters:
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: Authorization
in: header
required: false
example: Bearer {{OPEN_AI_KEY}}
schema:
type: string
responses: {}
/:
parameters: []
get:
summary: Billing Subscription
parameters: []
responses: {}
/v1/chat/completions:
parameters: []
post:
summary: Completions API
parameters:
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: Authorization
in: header
required: false
example: Bearer {{OPEN_AI_KEY}}
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/hooks/27/process_event:
parameters: []
post:
summary: Rephrase
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/hooks/7/process_event:
parameters: []
post:
summary: Fix spelling
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/linear/teams:
parameters: []
get:
summary: Get teams
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/linear/team_entities:
parameters: []
get:
summary: Get team entities
parameters:
- name: team_id
in: query
required: false
example: "{{linear_team_id}}"
schema:
type: string
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/linear/search_issue:
parameters: []
get:
summary: Search Issue
parameters:
- name: q
in: query
required: false
example: linear
schema:
type: string
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
/api/v1/accounts/1/integrations/linear/linked_issues:
parameters: []
get:
summary: Get linked issue
parameters:
- name: conversation_id
in: query
required: false
example: "446"
schema:
type: integer
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
/api/v1/accounts/1/integrations/linear/create_issue:
parameters: []
post:
summary: Create Issue
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
/api/v1/accounts/1/integrations/linear/create_comment:
parameters: []
post:
summary: Create Comment
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
issue_id:
type: string
comment:
type: string
/api/v1/accounts/1/integrations/linear/link_issue:
parameters: []
post:
summary: Link Issue
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
issue_id:
type: string
title:
type: string
conversation_id:
type: integer
/api/v1/accounts/1/integrations/linear/unlink_issue:
parameters: []
post:
summary: Unlink issue
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
link_id:
type: string
/api/v1/accounts/1/integrations/github/repositories:
parameters: []
get:
summary: Get repos
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/github//search_repositories:
parameters: []
get:
summary: Search repos
parameters:
- name: q
in: query
required: false
example: ai-sdk
schema:
type: string
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/github/repositories/chatwoot/chatwoot-mobile-app/assignees:
parameters: []
get:
summary: Get assignees
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/github/repositories/chatwoot/chatwoot-mobile-app/labels:
parameters: []
get:
summary: Get labels
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/github/repositories/muhsin-k/macbook-setup-guide/issues:
parameters: []
get:
summary: Get issues
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/integrations/github/conversations/587/repositories/muhsin-k/macbook-setup-guide/issues:
parameters: []
post:
summary: Create Issue
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
title:
type: string
format: style
body:
type: string
/api/v1/accounts/1/integrations/github/issues/1:
parameters: []
delete:
summary: Unlink issue
parameters:
- name: access-token
in: header
required: false
example: "{{access-token}}"
schema:
type: string
- name: client
in: header
required: false
example: "{{client}}"
schema:
type: string
- name: expiry
in: header
required: false
example: "{{expiry}}"
schema:
type: string
- name: token-type
in: header
required: false
example: "{{token-type}}"
schema:
type: string
- name: uid
in: header
required: false
example: "{{uid}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
responses: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
title:
type: string
format: style
body:
type: string
/fcm/send:
parameters: []
post:
summary: Test push
parameters:
- name: Authorization
in: header
required: false
example: Bearer {{fcm_server_key}}
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/captain/assistants:
parameters: []
get:
summary: Get Assistants
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/captain/assistants/1/scenarios:
parameters: []
get:
summary: Get scenarios
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
/api/v1/accounts/1/captain/assistants/tools:
parameters: []
get:
summary: Get Tools
parameters:
- name: Accept
in: header
required: false
example: "*/*"
schema:
type: string
- name: api_access_token
in: header
required: false
example: "{{api_access_token}}"
schema:
type: string
- name: Content-Type
in: header
required: false
example: application/json
schema:
type: string
responses: {}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment