Skip to main content
Retrieve a content resource

Authorizations

Authorization
string
header
required

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

Path Parameters

content_resource_id
string
required

The content resource's id.

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

Query Parameters

expand

Repeatable. Returns the named relation inline. One of: collection, event, cover_image_file, created_by, updated_by, tag_links.

Available options:
collection,
event,
cover_image_file,
created_by,
updated_by,
tag_links

Response

Success

object
enum<string>
required

Always content_resource.

Available options:
content_resource
id
string
required

Unique identifier for the object.

Example:

"cont_4h2o89z6qlpw"

created_at
string<date-time>
required

When the object was created.

updated_at
string<date-time>
required

When the object was last changed.

title
string
required

The title the resource is shown with.

description
string | null
required

A short summary of the resource. 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 resources in within their collection; the list itself is ordered by created_at.

type
enum<string>
required

What the resource points at. One of:

  • url: a link to a page, set in url.
  • calendar_event: an event on the community calendar, set in event_id.
Available options:
url,
calendar_event
url
string | null
required

Set for a url resource, null for a calendar_event one.

collection_id
string | null
required

Null once the collection it was filed under is deleted.

Example:

"coll_4h2o89z6qlpw"

event_id
string | null
required

Set for a calendar_event resource, null for a url one.

Example:

"cevt_4h2o89z6qlpw"

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 resource. 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 resource. Null until it is first changed, or when no member is recorded.

Example:

"prof_9f2b8c1d4e5a"

collection
object | null

The collection the resource is filed under. Present only when collection is expanded.

event
object | null

The event the resource points at. Present only when event is expanded.

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 resource. Present only when created_by is expanded.

updated_by
object | null

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

The tags on the resource. Present only when tag_links is expanded.