Back to InsightlyGets A Filtered List Of Knowledge Articles
To filter with a field name and value, both field_name and field_value parameters must be provided.
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Input
type: object
properties:
parameters:
type: object
properties:
field_name:
type: string
description: Optional, field name for object
field_value:
type: string
description: Optional, field value of the record
updated_after_utc:
type: string
description: Optional, earliest date when a record was last updated.
brief:
type: string
description: >-
Optional, true if response should only contain top level properties of
the record.
skip:
type: string
description: Optional, number of records to skip.
top:
type: string
description: Optional, maximum number of records to return in the response.
count_total:
type: string
description: >-
Optional, true if total number of records should be returned in the
response headers.
title: Parameters
Output
type: array
items:
type: object
title: KnowledgeArticle
properties:
ARTICLE_ID:
format: int64
maxLength: 0
type: integer
readOnly: true
CATEGORY_ID:
format: int64
maxLength: 0
type: integer
readOnly: false
FOLDER_ID:
format: int64
maxLength: 0
type: integer
readOnly: false
ARTICLE_NO:
format: int32
maxLength: 0
type: integer
readOnly: true
ArticleVersion:
format: string
maxLength: 0
type: string
readOnly: true
Status:
format: string
maxLength: 0
type: string
readOnly: true
Language:
format: string
maxLength: 0
type: string
readOnly: true
Title:
format: string
maxLength: 0
type: string
readOnly: false
Body:
format: string
maxLength: 0
type: string
readOnly: false
URL_SLUG:
format: string
maxLength: 255
type: string
readOnly: false
DOWNVOTE_COUNT:
format: int32
maxLength: 0
type: integer
readOnly: true
UPVOTE_COUNT:
format: int32
maxLength: 0
type: integer
readOnly: true
PROMOTED:
format: boolean
maxLength: 0
type: boolean
readOnly: false
FIRST_PUBLISHED_DATE_UTC:
format: date-time
maxLength: 0
type: string
readOnly: true
LAST_PUBLISHED_DATE_UTC:
format: date-time
maxLength: 0
type: string
readOnly: true
ARCHIVED_DATE_UTC:
format: string
maxLength: 20
type: string
readOnly: false
DATE_CREATED_UTC:
format: date-time
maxLength: 0
type: string
readOnly: true
DATE_UPDATED_UTC:
format: date-time
maxLength: 0
type: string
readOnly: true
OWNER_USER_ID:
format: int32
maxLength: 0
type: integer
readOnly: false
CREATED_USER_ID:
format: int32
maxLength: 0
type: integer
readOnly: true
ExternalLinkCount:
format: string
maxLength: 0
type: string
readOnly: true
CUSTOMFIELDS:
type: array
items:
type: object
title: CustomField
properties:
FIELD_NAME:
type: string
FIELD_VALUE:
type: object
TAGS:
type: array
items:
type: object
title: Tag
properties:
TAG_NAME:
maxLength: 255
minLength: 0
type: string