GET /api/collection
Changed onFetch a list of all Collections that the current user has read permissions for (:can_write is returned as an additional property of each Collection so you can tell which of these you have write permissions for.)
By default, this returns non-archived Collections, but instead you can show archived ones by passing ?archived=true.
By default, admin users will see all collections. To hide other user's collections pass in ?exclude-other-user-collections=true.
If personal-only is true, then return only personal collections where personal_owner_id is not nil.
Request
- Base URL(relative, and the document was published on a file host, not at the API’s origin)
- AuthAPI key in header X-API-Key
Query parameters
value must be a valid boolean string ('true' or 'false').
value must be a valid boolean string ('true' or 'false').
value must be a non-blank string.
value must be a valid boolean string ('true' or 'false').
Request body
Response
Successful response
Changes
- info
added optional request body
- info
the
queryrequest parameterarchivedbecame optional - info
the
queryrequest parameterexclude-other-user-collectionsbecame optional - info
the
queryrequest parameterpersonal-onlybecame optional - info
added the media type
application/jsonfor the response with the status
- info
- breaking
api path removed without deprecation
- info
endpoint added
- breaking