Contents x
Gets list of articles within project version
  • 16 Mar 2023
  • 1 Minute to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Gets list of articles within project version

  • Updated on 16 Mar 2023
  • 1 Minute to read
  • Contributors
  • Print
  • Dark
    Light
Get
/v2/ProjectVersions/{projectVersionId}/articles
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Path parameters
projectVersionId
string Required

The ID of the project version

Responses
200

Success

Example for 200 response due to invalid project version Id

200 response in get list of articles within project version

{
  "data": [
    {
      "id": "7db99386-2816-40f0-991f-174dgdscf",
      "title": "Why did we build Document360?",
      "public_version": 1,
      "latest_version": 1,
      "language_code": null,
      "hidden": false,
      "status": 2,
      "order": 1,
      "slug": "why did we build document360",
      "content_type": null
    }
  ],
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

400

Bad Request

Example for 400 response due to invalid Project version Id

400 bad response due to invalid Project version Id

{
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The supplied project version id does not exist in your project",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
data
extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next