Skip to content

List who a collection is shared with

GET
/collections/{id}/acls

Lists every sharing grant stored on a collection: who it names, the level, when it was last granted and by whom, and when it expires.

You need to be signed in. The collection’s owner and holders of collections.admin or system.admin granted globally can see the list. Being able to read the collection, having it shared with you, or the collection being public isn’t enough. Others get 403. The collection is looked up through each server’s cached copy of its details, so one that doesn’t exist answers 404, and a deleted one does too unless the server still holds an out-of-date copy.

Every stored grant is listed, including expired ones and old role or team grants, which give no access, most recently granted first, with no paging. Only a user grant that hasn’t expired lets someone read the collection, and the level makes no difference.

id
required
string format: uuid

The collection’s id.

The grants stored on the collection.

Array<object>
object
principal_type
required
string
Allowed values: user role team
principal_id
required

Who the grant is for, as stored: a user’s numeric ref, or a role’s or team’s UUID.

string
<= 64 characters
permission
required
string
Allowed values: read write admin
granted_at
required

When the grant was last written. Granting the same principal and level again resets it.

string format: date-time
granted_by_user_ref

The ref of the account that last wrote the grant, or null if none is recorded.

integer format: int64
nullable
expires_at

When the grant stops giving access, or null if it doesn’t expire. A grant whose time has been reached is still stored and listed, but gives no access.

string format: date-time
nullable

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"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed