Skip to content

Get a collection

GET
/collections/{id}

Returns one collection you’re allowed to read, with covers worked out for you.

You can read it if it’s public, it’s yours, it’s shared with you through a grant that hasn’t expired, or you hold system.admin. With public mode on, visitors who aren’t signed in can read public collections; with it off they get 401. Anything else answers 404, as a collection that doesn’t exist or is deleted does, and so does an error during the access check. Holders of system.admin also get deleted collections, but without deleted_at or deleted_reason, so the response doesn’t show that it’s deleted.

Each server keeps a cached copy of the collection’s details, so they can be out of date; the access check and covers are worked out fresh on every request.

id
required
string format: uuid

The collection’s id.

The collection

A named collection of posts, owned by one user. Who can read it is set by visibility, how posts get into it by membership, and whether it carries an expiry date by expires_at.

object
id
required
string format: uuid
owner_user_ref
required
integer format: int64
name
required
string
description
required
string
visibility
required

Who may read the collection. A public collection can be read by any signed-in user, and by visitors who aren’t signed in when the instance is in public mode. Any other collection can be read by its owner, by users it has been shared with through a grant that hasn’t expired, and by holders of system.admin. As installed, org-only, followers and explicit-share add no readers beyond those, so they behave like private.

string
Allowed values: public private org-only followers explicit-share
membership
required

How posts get into the collection. Only manual is in use: posts are added and removed one at a time. query and hybrid are reserved, and saving a search as a collection stores a fixed set of its results.

string
Allowed values: manual query hybrid
expires_at

An expiry date set on the collection, or null. Nothing acts on it at present: the collection stays readable and listed after that time.

string format: date-time
nullable
purpose

An optional free-form label for what the collection is for, such as for_review. It doesn’t change how the collection behaves.

string
nullable
origin_server_id

The server the collection came from, or null for a collection created here.

string format: uuid
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time
deleted_at

When the collection was deleted. It appears only in the listing of deleted collections that holders of system.admin can ask for with include_deleted=true; elsewhere it is absent.

string format: date-time
nullable
deleted_reason

Why the collection was deleted, when a reason was given. It appears only with deleted_at.

string
nullable
cover_asset_id

The cover picture the curator chose, or null when the cover is made from the collection’s posts. It can be any asset the curator was allowed to see when choosing it, not only one in the collection.

This is the setting, not what to show: covers says what to paint, and readers who may not see the chosen picture get the posts’ pictures instead.

string format: uuid
nullable
featured_cover_asset_id

The cover to use for this collection on the featured rail, or null for no separate choice. The rail tries this cover, then cover_asset_id, then a cover made from the collection’s posts, skipping any the reader may not see. Like cover_asset_id, it can be any asset the curator was allowed to see, and it is the setting rather than what to show.

string format: uuid
nullable
featured_cover_focal_x

Where the featured rail’s crop is centred across the picture, from 0 at the left edge to 1 at the right, measured on the original picture. null means centred. It is set or cleared together with featured_cover_focal_y.

number format: double
nullable
featured_cover_focal_y

Where the featured rail’s crop is centred down the picture, from 0 at the top to 1 at the bottom. See featured_cover_focal_x.

number format: double
nullable
cover_focal_x

Where the collection card’s 4:3 crop is centred across the picture, from 0 at the left edge to 1 at the right, measured on the original picture. null means centred. It is set or cleared together with cover_focal_y, and cleared when the cover picture changes without new framing. Apply it to a full-picture rendition such as preview, not to col, which is already a square centre crop.

number format: double
nullable
cover_focal_y

Where the collection card’s crop is centred down the picture, from 0 at the top to 1 at the bottom. See cover_focal_x.

number format: double
nullable
featured_cover_zoom

How far the featured rail’s crop is tightened, from 1 to 4: at 1 the crop just fits, and at 2 it shows a quarter of that area. null means no zoom, which looks the same as 1.

number format: double
nullable
cover_zoom

How far the collection card’s crop is tightened, from 1 to 4. See featured_cover_zoom.

number format: double
nullable
covers

What to paint for the collection’s tile: the chosen cover if you may see it and a col rendition is recorded for it, otherwise up to four pictures from the collection’s posts that you may see and that have a recorded col rendition, in the order the posts were added. Each picture appears at most once.

It is absent where a route doesn’t compose covers, as in the list of collections holding a post; an empty array means there is nothing to show.

Array<object>

One picture in a collection’s cover. It is included only if you may see it and a col rendition is recorded for it; that record isn’t a check that the file can be fetched.

object
asset_id
required

The asset to show. A col rendition is recorded for it, fetched from /assets/{asset_id}/variants/col.

string format: uuid
preview_available
required

Whether a preview rendition is also recorded for the asset: the full picture to crop from when the collection has a focal point or zoom. When it is false, use col with a centred crop.

boolean

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed