Skip to content
Dixa API/
/
Get collection

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Get collection

Request

Get a knowledge collection by id

Security
ApiKeyAuth
Path
collectionIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/collections/{collectionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The knowledge collection

Bodyapplication/json
dataobject(Collection)required
data.​idstringrequired
data.​titlestringrequired
data.​descriptionstring
data.​internalKbEnabledbooleanrequired
data.​restrictionsobject(Restrictions)required
data.​restrictions.​isRestrictedbooleanrequired
data.​restrictions.​inheritedRestrictionsArray of objects(InheritedRestriction)
Response
application/json
{
  "data": {
    "id": "78dfb531-2e1e-4ffc-bd18-fdad68cd2419",
    "title": "Test Collection",
    "description": "This is a test collection",
    "internalKbEnabled": true,
    "restrictions": { … }
  }
}

Get collection catalog

Request

Get collection catalog, including all categories and articles

Security
ApiKeyAuth
Path
collectionIdstring(uuid)required
Query
languagestring

Language in which the article translations will be returned. If not provided, the default language will be used.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/collections/{collectionId}/catalog?language=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The knowledge collection catalog

Bodyapplication/json
dataobject(CollectionCatalogItem)required
data.​categoriesArray of objects(CategoryCatalogItem)
data.​articlesArray of objects(ArticleCatalogItem)
Response
application/json
{
  "data": {
    "categories": [ … ],
    "articles": [ … ]
  }
}

Get category

Request

Get a knowledge category by id

Security
ApiKeyAuth
Path
categoryIdstring(uuid)required
Query
languagestring

Language in which the article translations will be returned. If not provided, the default language will be used.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/categories/{categoryId}?language=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The category

Bodyapplication/json
dataobject(Category)required
data.​idstringrequired
data.​titleobject(TranslationTitle)
data.​isDefaultLocationboolean
data.​isLockedbooleanrequired
data.​restrictionsobject(Restrictions)required
data.​restrictions.​isRestrictedbooleanrequired
data.​restrictions.​inheritedRestrictionsArray of objects(InheritedRestriction)
data.​parentCategorystring
data.​parentCollectionsArray of strings
Response
application/json
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": { … },
    "isDefaultLocation": true,
    "isLocked": false,
    "restrictions": { … },
    "parentCategory": "222e4567-e89b-12d3-a456-426614174111",
    "parentCollections": [ … ]
  }
}

Get category translations

Request

Get the knowledge category translations

Security
ApiKeyAuth
Path
categoryIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/categories/{categoryId}/translations' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The category translations

Bodyapplication/json
dataobject(CategoryTranslations)required
data.​titlesArray of objects(TranslationTitle)
Response
application/json
{
  "data": {
    "titles": [ … ]
  }
}

Get article

Request

Get a knowledge article by id

Security
ApiKeyAuth
Path
articleIdstring(uuid)required
Query
languagestring

Language in which the article translations will be returned. If not provided, the default language will be used.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/articles/{articleId}?language=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The knowledge article

Bodyapplication/json
dataobject(Article)required
data.​idstringrequired
data.​isDefaultLocationboolean
data.​translationobject(Translation)
data.​tagsArray of strings
data.​createdAtstring(date-time)required
data.​updatedAtstring(date-time)required
data.​indexedAtstring(date-time)
data.​createdBystring
data.​updatedBystring
data.​ownedBystring
data.​indexedBystring
data.​restrictionsobject(Restrictions)required
data.​restrictions.​isRestrictedbooleanrequired
data.​restrictions.​inheritedRestrictionsArray of objects(InheritedRestriction)
data.​parentCategorystring
data.​parentCollectionsArray of strings
Response
application/json
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isDefaultLocation": true,
    "translation": { … },
    "tags": [ … ],
    "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
    "updatedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "indexedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "ownedBy": "123e4567-e89b-12d3-a456-426614174000",
    "indexedBy": "123e4567-e89b-12d3-a456-426614174000",
    "restrictions": { … },
    "parentCategory": "123e4567-e89b-12d3-a456-426614174000",
    "parentCollections": [ … ]
  }
}

Get article translations

Request

Get a knowledge article translations

Security
ApiKeyAuth
Path
articleIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/articles/{articleId}/translations' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The article translations

Bodyapplication/json
dataobject(ArticleTranslations)required
data.​translationsobject(TranslationList)required
data.​translations.​draftArray of objects(ArticleTranslation)
data.​translations.​publishedArray of objects(ArticleTranslation)
Response
application/json
{
  "data": {
    "translations": { … }
  }
}

List collections

Request

Paginated list knowledge collections

Security
ApiKeyAuth
Query
pageLimitinteger(int32)

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/collections?pageLimit=0&pageKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A list of knowledge collections

Bodyapplication/json
dataArray of objects(Collection)
Response
application/json
{
  "data": [
    { … }
  ]
}

Organization

Operations