Appearance

List Collections ​

Endpoint ​

http
GET /unified/knowledge-base/collections
Integrations supported
  • Coda
  • Discourse
  • Help Scout Docs
  • Intercom
  • Readme
  • Webflow
  • Zendesk - Help Center

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
type
string

The type of the collection

All possible enum values:
  • category
  • section
  • topic
Required in
  • Zendesk - Help Center

Response Body ​

result
object[]

List of Collections

id
string
REQUIRED · 

The unique identifier for the collection

Supported in
  • Coda
  • Discourse
  • Help Scout Docs
  • Intercom
  • Readme
  • Webflow
  • Zendesk - Help Center
name
string

The name of the collection

Supported in
  • Coda
  • Discourse
  • Help Scout Docs
  • Intercom
  • Readme
  • Webflow
  • Zendesk - Help Center
description
string

The description of the collection

Supported in
  • Discourse
  • Help Scout Docs
  • Intercom
  • Webflow
  • Zendesk - Help Center
type
string

The type of the collection

Supported in
  • Coda
  • Discourse
  • Help Scout Docs
  • Intercom
  • Readme
  • Webflow
  • Zendesk - Help Center
space
object

The space the collection belongs to

Supported in
  • Coda
  • Help Scout Docs
  • Intercom
id
string

The unique identifier for the space

name
string

The name of the space

parent
object

The parent of the collection

Supported in
  • Coda
  • Intercom
  • Zendesk - Help Center
id
string

The unique identifier for the parent

type
string

The type of the parent

urls
object[]

The urls of the collection

Supported in
  • Coda
  • Help Scout Docs
  • Intercom
  • Webflow
  • Zendesk - Help Center
url
string

The url of the collection

type
string

The type of the url

All possible enum values:
  • view
  • edit
  • public_view
created_at
string · date-time

The date and time the collection was created

Supported in
  • Coda
  • Help Scout Docs
  • Intercom
  • Readme
  • Webflow
  • Zendesk - Help Center
updated_at
string · date-time

The date and time the collection was last updated

Supported in
  • Coda
  • Help Scout Docs
  • Intercom
  • Webflow
  • Zendesk - Help Center
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.