{ "opencollection": "1.0.0", "info": { "name": "Outline AccessRequests Collections API", "version": "0.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Collections", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a collection", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.info", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve the details of a collection by its unique identifier." }, { "info": { "name": "Retrieve a collections document structure", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.documents", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the document structure of a collection as a tree of navigation nodes, representing the hierarchy of documents within the collection." }, { "info": { "name": "List all collections", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.list", "body": { "type": "json", "data": "{}" } }, "docs": "List all collections that the authenticated user has access to." }, { "info": { "name": "Create a collection", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.create", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new collection with the specified name, description, icon, color, and permission settings. Collections are used to organize documents." }, { "info": { "name": "Update a collection", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.update", "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing collection's properties such as name, description, icon, color, sharing settings, or permission level." }, { "info": { "name": "Add a collection user", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.add_user", "body": { "type": "json", "data": "{}" } }, "docs": "This method allows you to add a user membership to the specified collection." }, { "info": { "name": "Remove a collection user", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.remove_user", "body": { "type": "json", "data": "{}" } }, "docs": "This method allows you to remove a user from the specified collection." }, { "info": { "name": "List all collection memberships", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.memberships", "body": { "type": "json", "data": "{}" } }, "docs": "This method allows you to list a collections individual memberships. It's important to note that memberships returned from this endpoint do not include group memberships." }, { "info": { "name": "Add a group to a collection", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.add_group", "body": { "type": "json", "data": "{}" } }, "docs": "This method allows you to give all members in a group access to a collection." }, { "info": { "name": "Remove a collection group", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.remove_group", "body": { "type": "json", "data": "{}" } }, "docs": "This method allows you to revoke all members in a group access to a collection. Note that members of the group may still retain access through other groups or individual memberships." }, { "info": { "name": "List all collection group members", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.group_memberships", "body": { "type": "json", "data": "{}" } }, "docs": "This method allows you to list a collections group memberships. This is the list of groups that have been given access to the collection." }, { "info": { "name": "Delete a collection", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.delete", "body": { "type": "json", "data": "{}" } }, "docs": "Delete a collection and all of its documents. This action can’t be undone so please be careful." }, { "info": { "name": "Export a collection", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.export", "body": { "type": "json", "data": "{}" } }, "docs": "Triggers a bulk export of the collection in markdown format and their attachments. If documents are nested then they will be nested in folders inside the zip file. The endpoint returns a `FileOperation` that can be queried to track the progress of the export and get the url for the final file." }, { "info": { "name": "Export all collections", "type": "http" }, "http": { "method": "POST", "url": "https://app.getoutline.com/api/collections.export_all", "body": { "type": "json", "data": "{}" } }, "docs": "Triggers a bulk export of multiple collections and their documents. The endpoint returns a `FileOperation` that can be queried through the fileOperations endpoint to track the progress of the export and get the url for the final file." } ] } ], "bundled": true }