Skip to main content
Retrieve a content collection

Authorizations

Authorization
string
header
required

A Tightknit admin API key, sent as Authorization: Bearer <key>.

Path Parameters

content_collection_id
string
required

The content collection's id.

Pattern: ^coll_[a-zA-Z0-9]{12}$

Query Parameters

expand

Repeatable. Returns the named relation inline. One of: cover_image_file, created_by, updated_by, tag_group_links.

Available options:
cover_image_file,
created_by,
updated_by,
tag_group_links

Response

Success

object
enum<string>
required

Always content_collection.

Available options:
content_collection
id
string
required

Unique identifier for the object.

Example:

"coll_4h2o89z6qlpw"

created_at
string<date-time>
required

When the object was created.

updated_at
string<date-time>
required

When the object was last changed.

name
string
required

The name the collection is shown with.

slug
string
required

The URL segment of the collection's page on the community site.

description
string | null
required

What the collection holds. Null when not set.

cover_image_url
string | null
required

A cover image given as a URL. Alternative to cover_image_file_id, not derived from it: read the expanded file’s url first and fall back to this.

position
integer
required

The order Studio shows collections in; the list itself is ordered by created_at.

resources_count
integer
required

How many resources are filed under the collection.

Required range: x >= 0
cover_image_file_id
string | null
required

A cover image uploaded as a file. Alternative to cover_image_url; expand cover_image_file for its url.

Example:

"file_2b3c4d5e6f7g"

created_by_id
string | null
required

The id of the member who created the collection. Null when no member is recorded as its creator.

Example:

"prof_9f2b8c1d4e5a"

updated_by_id
string | null
required

The id of the member who last changed the collection. Null until it is first changed, or when no member is recorded.

Example:

"prof_9f2b8c1d4e5a"

cover_image_file
object | null

The cover image file. Present only when cover_image_file is expanded.

created_by
object | null

The member who created the collection. Present only when created_by is expanded.

updated_by
object | null

The member who last changed the collection. Present only when updated_by is expanded.

The tag groups whose tags can be put on resources in the collection. Present only when tag_group_links is expanded.