Skip to content
Dixa API/
/
Get article

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.

GET
/v1/knowledge/articles/{articleId}
curl -i -X GET \
  'https://dev.dixa.io/v1/knowledge/articles/{articleId}?language=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The knowledge article

Bodyapplication/json
dataobject(Article)required
Response
{
  "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": [ … ]
  }
}