Skip to main content
GET
/
training
Get all custom trainings
curl --request GET \
  --url https://api.open.cx/training \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "organization_id": "<string>",
    "question": "<string>",
    "answer": "<string>",
    "is_draft": true,
    "accepted_by": 123,
    "learned_from_session_id": "<string>",
    "type": "BEHAVIORAL",
    "restricted_to_segments": [
      "<string>"
    ],
    "restricted_to_channels": [
      "web"
    ],
    "created_at": "<string>",
    "updated_at": "<string>",
    "directory_id": "<string>",
    "draft_payload": "<unknown>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Returns all custom trainings

​
id
string
required

The ID of the custom training

​
organization_id
string
required
​
question
string
required
​
answer
string
required

The answer of the custom training

​
is_draft
boolean
required

The draft status of the custom training

​
accepted_by
number | null
required
​
learned_from_session_id
string | null
required
​
type
enum<string>
required

The type of custom training

Available options:
BEHAVIORAL,
SCENARIO_SPECIFIC
​
restricted_to_segments
string[]
required

(is array is empty, instruction works for all segments, if array contains segments, instruction is limited to those segments

​
restricted_to_channels
enum<string>[]
required

(is array is empty, instruction works for all channels, if array contains channels, instruction is limited to those channels

Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
instagram,
messenger,
api,
web_voice
​
created_at
string
required
​
updated_at
string
required
​
directory_id
string | null
required

The directory ID of the custom training

​
draft_payload
any | null

Draft payload with structured data