get
https://api.customerly.io/v2/knowledge-base/collections/
Returns complete information about a collection including its parent collection
details if it exists. Use this endpoint when you need full collection metadata
including icon, slug, and sort order information.
Content Visibility
The response includes contact_segment_visibilities and company_segment_visibilities — arrays of
{segment_id, is_inherited} objects that define which contact/company segments can access this collection.
Visibility rules on a collection apply in two contexts:
- Aura (AI assistant): only contacts/companies in those segments can interact with the collection's content.
- Help Center: if the help center is published, only contacts/companies in those segments will see
this collection and its articles in the public help center.
Visibility rules set on a collection are automatically inherited by all articles inside it that do
not have their own explicit visibility rules.
- An empty array means no restrictions apply (visible to everyone).
Use PUT /knowledge-base/collections/collections to update visibilities.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
401Authentication required
404Collection not found