openapi: 3.0.0 info: version: 0.0.2 title: Superhuman Docs Admin Account Folders API license: name: Superhuman Developer Terms url: https://docs.superhuman.com/trust/developer description: "# Introduction\n\nThe Superhuman Docs Admin API is a RESTful API that allows programmatic access to administrative reports & capabilities within Superhuman Docs (formerly Coda).\n\nAccess to the Admin API is limited to enterprise organizations.\nOnly organization admins can use the Admin API for resources related to their organization.\n\nAs we update and release newer versions of the API, we reserve the right to remove\nolder APIs and functionality with a 3-month deprecation notice. We will post about such changes as well as announce\nnew features in the [Developers Central](https://connect.superhuman.com/c/developers-central) section of our Community,\nand update the [API updates](https://docs.superhuman.com/api-updates) doc.\n\n# Using the Admin API\n\nThe Superhuman Docs Admin REST API is designed to be straightforward to use. You can use the language and platform of your choice\nto make requests. To get a feel for the API, you can also use a tool like [Postman](https://www.getpostman.com/) or\n[Insomnia](https://insomnia.rest/).\n\n## API Endpoint\n\nThis API uses a base path of `https://docs.superhuman.com/apis/admin/v1`.\n\n## Object Hierarchy\n\n### Organizations\n\nEnterprise customers have access to the Organization, an object that contains policy, rules, and audit events\nfor a set of workspaces and one or more domains. Users accessing Superhuman Docs via an Organization-registered domain are\nsubject to that Organization's policies including allowed forms of authentication,\ndoc & Pack sharing restrictions, etc.\n\n### Workspaces\n\nA workspace is your home base for all things Superhuman Docs. It will store your documents in an organized way, and you'll invite\nmembers into the workspace to help you get the job done. A workspace can be free or paid (depending on your plan),\nand as the workspace's Doc Maker or Doc Maker (Admin), you'll be able to dictate the rules for how it works.\n\n[Learn more about Workspaces in our help center](https://help.coda.io/hc/en-us/articles/39555775119117-Create-and-manage-your-Coda-workspace).\n\n### Folders\n\nWe use folders to keep docs organized in the workspace (think departments, teams, and projects). Your docs are\nwhere the true work gets done with all of your tables, text, and app-like solutions. Folders contain docs within\nthe workspace.\n\n[Learn more about Folders in our help center](https://help.coda.io/hc/en-us/articles/39555852126605-Create-and-share-folders).\n\n### Docs\n\nDocuments are foundational, top-level collaborative projects that contain pages.\n\n### Pack configurations\n\nPack configurations are the settings that define how a Pack may be used within an organization.\n\n### Pack configuration permissions\n\nPack configuration permissions are the settings that define which principals may use a Pack configuration.\n\n### Pack requests\n\nWhen Pack configurations are turned on inside an organization. Pack requests are requests to use a Pack submitted by\nusers in the organization.\n\n### Pages\n\nIndividual pages within a doc offer canvases containing rich text, tables, controls, and other objects.\n\n## Audit events\n\nAudit events contain records of user login/logout activities and other operations performed within a Superhuman Docs organization.\nAudit events are critical to an enterprise's Security Monitoring efforts. It enables Security professionals to proactively\nanalyze the audit events for any suspicious behavior within a Superhuman Docs organization and help them in forensic investigations\nin case of a security breach. Audit events also enable administrators to write their own applications to understand their\nusers' usage of Superhuman Docs.\n\n### Audit event actions\n\nThe following entity types and actions are audited.\n\n| Entity Type | Action Name | Description |\n| ----------- | ----------- | ----------- |\n| agentInstance | AcceptCustomAgentInvitation | Accept an invitation to access a custom agent |\n| agentInstance | AgentScheduleTriggerFired | A scheduled agent trigger fired |\n| agentInstance | CreateAgentInstance | Create a new agent instance |\n| agentInstance | CreateCustomAgentInvitation | Send an invitation to share a custom agent |\n| agentInstance | DeclineCustomAgentInvitation | Decline an invitation to access a custom agent |\n| agentInstance | DeleteAgentInstance | Delete an agent instance |\n| agentInstance | DeleteCustomAgentInvitation | Revoke a pending invitation to a custom agent |\n| agentInstance | StartAgentChat | Start a new agent chat session |\n| agentInstance | UpdateAgentInstance | Update an agent instance |\n| agentInstance | UpdateAgentInstanceSharing | Update sharing permissions on an agent instance |\n| agentToolCall | ApproveAgentToolCall | Approve a tool call during an agent instance session |\n| agentToolCall | ExecuteAgentToolCall | Execute a tool call during an agent instance session |\n| agentToolCall | IgnoreAgentToolCall | Ignore a tool call during an agent instance session |\n| agentToolCall | RejectAgentToolCall | Reject a tool call during an agent instance session |\n| apiToken | DeleteApiToken | Delete an API token |\n| apiToken | GenerateApiToken | Generate an API token |\n| billingAccount | AddBillingGroup | Add a billing group to a billing account |\n| billingAccount | AddBillingGroupAdmin | Assign a billing group admin |\n| billingAccount | DeleteBillingGroup | Delete a billing group from a billing account |\n| billingAccount | RemoveBillingGroupAdmin | Remove a billing group admin |\n| billingAccount | UpdateBillingAccountSettings | Update settings for a billing account |\n| brainQuery | BrainStructuredQuery | Query Coda Brain for structured data |\n| brainQuery | BrainUnstructuredQuery | Query Coda Brain for unstructured data |\n| doc | AddDocPack | Install a Pack within a doc |\n| doc | CopyDoc | Copy a doc to a new location |\n| doc | CopyPages | Copy pages and sub pages within a doc to a new location |\n| doc | CopyTemplate | Copy template to an existing doc |\n| doc | CreateDoc | Create a new doc |\n| doc | DeleteAllReferencingSyncPageTunnels | Delete all sync page tunnels referencing a doc |\n| doc | DeleteDoc | Delete a doc |\n| doc | DeleteDocPack | Remove usage of a Pack from a doc |\n| doc | EditDoc | Edit a doc |\n| doc | ExportDocContent | Export doc content |\n| doc | MoveDoc | Move a doc to a different folder |\n| doc | OpenDoc | Opening a doc for reading, commenting or editing. |\n| doc | ReviveDoc | Revive a deleted doc |\n| doc | SubmitForm | Submit through a form |\n| doc | UpdateDocPermissions | Update sharing permissions on a doc |\n| docPackConnection | CreateExternalConnection | Create a new Pack connection |\n| docPackConnection | DeleteExternalConnection | Delete a Pack connection |\n| docPackConnection | UpdateExternalConnection | Update a Pack connection |\n| folder | CreateFolder | Create a new folder |\n| folder | DeleteFolder | Delete a folder |\n| folder | MoveFolder | Move a folder to a different parent |\n| folder | UpdateFolderMembership | Update membership on a folder |\n| folder | UpdateFolderPermissions | Update sharing permissions on a folder |\n| folder | UpdateFolderSettings | Update folder settings |\n| group | CreateGroup | Create a new group |\n| group | DeleteGroup | Delete a group |\n| group | UpdateGroup | Update group properties |\n| import | CompleteImport | Complete an import |\n| import | FailImport | Fail an import |\n| import | OnboardItem | Onboard a single source item during an import |\n| import | StartImport | Start an import |\n| importPreference | AddImportPreference | Add an import preference for an importer |\n| importPreference | DeleteImportPreference | Delete an import preference for an importer |\n| importPreference | UpdateImportPreference | Update an import preference for an importer |\n| ingestion | CreateIngestion | Create a new Coda Brain ingestion |\n| ingestion | CreateIngestionPermissions | Create Coda Brain ingestion permissions |\n| ingestion | DeleteIngestion | Delete a Coda Brain ingestion |\n| ingestion | DeleteIngestionPermissions | Delete Coda Brain ingestion permissions |\n| ingestion | UpdateIngestion | Update a Coda Brain ingestion |\n| legalHold | CreateLegalHold | Create a new legal hold |\n| legalHold | DeleteLegalHold | Delete a legal hold |\n| legalHold | UpdateLegalHold | Update legal hold |\n| legalHoldExport | CreateLegalHoldExport | Create a new legal hold export |\n| legalHoldExport | DeleteLegalHoldExport | Delete a legal hold export |\n| organization | AddBlockedDomains | Add domains to the blocked domains list |\n| organization | AddTrustedDomains | Add domains to the trusted domains list |\n| organization | ClaimDocOwnership | Claim ownership of a doc after the owner is deactivated |\n| organization | OrganizationPackAccessRequestBlocked | A user attempted to request Pack access while the organization administrator has disabled Pack access requests |\n| organization | OrganizationPackAccessRequested | A user requested access to a Pack |\n| organization | RemoveBlockedDomains | Remove domains from the blocked domains list |\n| organization | RemoveTrustedDomains | Remove domains from the trusted domains list |\n| organization | TransferDocs | Transfer docs from one user to another |\n| organization | UpdateOrganizationSettings | Update organization settings |\n| organization | UpdateOrganizationUserActivation | Update a user's activation status in an organization |\n| organization | UpdateOrganizationUserRole | Add or remove user from organization roles |\n| organization | UpdateWorkspaceAiControls | Update workspace AI controls |\n| pack | AddPackConfigurationPermission | Add a Pack configuration permission |\n| pack | AllowPackAccessRequest | A user was granted access to a Pack |\n| pack | AutoApprovePack | A Pack was auto-approved upon creation per the organization policy |\n| pack | CancelPackReview | Cancel a pending Pack review |\n| pack | CreatePack | Create a new Pack |\n| pack | CreatePackConfiguration | Create a new Pack configuration |\n| pack | CreatePackInvitation | Create a Pack invitation |\n| pack | CreatePackReview | Submit a Pack for Superhuman GO review |\n| pack | DeleteAllConfigurationsOnPack | Delete all configurations for a Pack |\n| pack | DeletePack | Delete a Pack |\n| pack | DeletePackConfiguration | Delete a Pack configuration |\n| pack | DeletePackConfigurationOAuth | Delete OAuth configuration metadata associated with a Pack configuration |\n| pack | DenyPackAccessRequest | A user was denied access to a Pack |\n| pack | RemovePackConfigurationPermission | Delete a Pack configuration permission |\n| pack | SetPackConfigurationOAuth | Set OAuth configuration metadata associated with the Pack configuration |\n| pack | SetPackConfigurationPermissions | Set permissions for a Pack configuration |\n| pack | UpdatePackConfiguration | Update a Pack configuration |\n| pack | UpdatePackListingDraft | Update a Pack listing draft |\n| pack | UpdatePackPermissions | Update Pack permissions |\n| packControl | SetPackControl | Set Pack control for an organization |\n| syncPage | OpenSyncPage | Opening a sync page for reading. |\n| syncPageTunnel | CreateSyncPageTunnel | Create a sync page tunnel |\n| syncPageTunnel | DeleteSyncPageTunnel | Delete a sync page tunnel |\n| syncPageTunnel | UpdateSyncPageTunnel | Update a sync page tunnel |\n| user | CreateUser | Create a new user |\n| user | DeleteUser | Delete an existing user |\n| user | ExportUserData | Export own personal data |\n| user | IssueOAuthToken | Issue an OAuth access/refresh token for a user |\n| user | LogInUser | Login activity of a user |\n| user | LogOutUser | Logout activity of a user |\n| user | RenewOAuthToken | Renew an OAuth access token for a user |\n| user | ResetUserPassword | Reset a user's password |\n| user | RevokeAllOAuthTokens | Revoke all OAuth tokens for a user |\n| user | RevokeOAuthToken | Revoke a single OAuth refresh token for a user |\n| user | UpdateUserAccount | Update a user's account details |\n| user | UpdateUserPassword | Update a user's password |\n| webhook | CreateWebhook | Create a new webhook subscription |\n| webhook | DeleteWebhook | Delete a webhook subscription |\n| webhook | ResetWebhook | Resets a webhook subscription |\n| webhook | UpdateWebhook | Updates parameters for an existing webhook subscription |\n| workspace | CreateCustomIcon | Create a custom icon in a workspace |\n| workspace | CreateWorkspace | Create a new workspace |\n| workspace | DeleteCustomIcon | Delete a custom icon in a workspace |\n| workspace | DeleteWorkspace | Delete a workspace |\n| workspace | ExportWorkspaceMembers | Export workspace members roster |\n| workspace | OffboardWorkspaceUser | Offboard a removed user from a workspace |\n| workspace | PinDocToWorkspace | Pin a doc to a workspace |\n| workspace | ReinstateWorkspaceUser | Allow a user to be re-added to a workspace |\n| workspace | UnpinDocFromWorkspace | Unpin a doc from a workspace |\n| workspace | UpdateWorkspaceSettings | Update workspace settings |\n| workspace | UpdateWorkspaceUserBrainRole | Update a user's Brain role in a workspace |\n| workspace | UpdateWorkspaceUserRole | Update a user's role in a workspace |\n\n### More information\nFor more information about the Superhuman Docs Admin API and these events,\n[detailed information and examples are available](https://docs.superhuman.com/@documentation/admin-audit-api-events-and-documentation).\n\n## Webhooks\n\nWebhooks enable an application to receive notifications of audit events in Superhuman Docs as they occur.\n\nRather than having to \"poll\" repeatedly for new audit events, a webhook will \"push\" events to your internet-accessible\nendpoint via HTTP `POST` requests. This can be much more efficient and convenient for an internet-accessible service.\n\nIt is important to note that webhooks do require a server or server-like endpoint accesible on the internet at all times\nto receive these notifications. For simpler scenarios, it may be easier to just poll for audit events rather than host\nand maintain a server on the internet.\n\n### Webhook Considerations\n\nThis webhook implementation aims to deliver events within a few minutes of occurring under normal operating conditions.\n\nThe system will attempt retries when it detects failures, so it will be possible for you to receive the same events\nmore than once depending on errors or timeouts occurring in your server or in the network infrastructure between Superhuman Docs\nand your server. Once delivered successfully, it is not possible to replay webhook notifications.\n\nTargets are expected to respond within 10 seconds before delivery times out and is considered a failure.\n\nFailures are retried using exponential backoff timing; after 8 hours of consecutive failures, Superhuman Docs will give up and\nplace the webhook into a disabled state.\n\n### Webhook Setup\n\nOnce a new webhook connection is established, an initial handshake will be attempted in order to prove that the target\nis available on the internet and is owned by the registering entity. In addition, any time the webhook is updated\nto point to a new target URL, the handshake procedure will be kicked off.\n\nAfter the initial handshake completes successfully, new audit events will immediately begin to flow to the target.\n\nIn the event that the handshake fails, the `reset` API can be used to force the webhook to retry the handshake process.\n\n### Webhook Handshake details\n\nTo prove that the target URL is available on the internet and is a valid webhook target, a handshake process is\nstarted anytime a new target URL is set on on a webhook. This process is asynchronous to the webhook setup API call.\n\nSuperhuman Docs will send a HTTP `GET` request to the registered target URL with a HTTP header named `X-Webhook-Code`. The\ntarget must respond with a standard `200` or `204` HTTP response code and echo back the same header key and its value.\n\n### Webhook Payload details\n\nOnce the webhook handshake has completed successfully, Superhuman Docs will send batches of audit events to the target URL using\nHTTP `POST` requests.\n\nEach notifications the target receives will include:\n\n* A `X-Webhook-Signature` header which enables the server to verify the payload is genuine and originated from Superhuman Docs.\nThis code is a SHA-256 HMAC of the stringified body of the POST request using the Superhuman Docs-generated secret key available\non the webhook object.\n* A JSON body with key `events` which contains an array of audit events using the same format as\nreturned by the `listEvents` endpoint detailed below.\n\n### Payload verification\n\nSample javascript code fragment for verifying a webhook payload originated from Superhuman Docs:\n\n```javascript\nconst crypto = require('crypto');\n\n// This field is available on the Superhuman Docs webhook object.\nconst signatureKey = 'some value';\n\n// These come from the webhook `POST` request to your server\nconst headers = {'X-Webhook-Signature': 'abc123'};\nconst body = {events: []};\n\nconst calculatedSignature = crypto\n .createHmac('SHA256', signatureKey)\n .update(JSON.stringify(body))\n .digest(\"hex\");\n\nconst isValidSignature = crypto.timingSafeEqual(\n Buffer.from(calculatedSignature),\n Buffer.from(headers['X-Webhook-Signature']),\n);\n```\n\n## List Endpoints\n\nEndpoints supporting listing of resources have the following fields:\n\n - `items`: An array containing the listed resources, limited by the `limit` or `pageToken` query parameters\n - `nextPageLink`: If more results are available, an API link to the next page of results\n - `nextPageToken`: If more results are available, a page token that can be passed into the `pageToken` query parameter\n\n**The maximum page size may change at any time, and may be different for different endpoints.** Please do not rely on it\nfor any behavior of your application. If you pass a `limit` parameter that is larger than our maximum allowed limit,\nwe will only return as many results as our maximum limit. You should look for the presence of the `nextPageToken` on the\nresponse to see if there are more results available, rather than relying on a result set that matches your provided limit.\n\nTo fetch a subsequent page of results, pass the `pageToken` parameter. Set this parameter to the value given to you as the `nextPageToken`\nin a page response. If no value is provided, there are no more results available. You only need to pass the `pageToken` to get\nthe next page of results, you don't need to pass any of the parameters from your original request, as they are all\nimplied by the `pageToken`. Any other parameters provided alongside a `pageToken` will be ignored.\n\n## Rate Limiting\n\nThe Superhuman Docs Admin API sets a reasonable limit on the number of requests that can be made per minute. Once this limit is\nreached, calls to the API will start returning errors with an HTTP status code of 429.\n\n## OpenAPI/Swagger Spec\n\nIn an effort to standardize our API and make it accessible, we offer an OpenAPI 3.0 specification:\n\n- [OpenAPI 3.0 spec - YAML](https://docs.superhuman.com/apis/admin/v1/openapi.yaml)\n- [OpenAPI 3.0 spec - JSON](https://docs.superhuman.com/apis/admin/v1/openapi.json)\n" termsOfService: https://superhuman.com/legal/terms contact: name: Developer Support url: https://superhuman.com/developers email: care@superhuman.com x-logo: url: https://cdn.coda.io/icons/png/color/superhuman-docs-128.png backgroundColor: transparent altText: Superhuman Docs Admin API href: '#' servers: - url: https://docs.superhuman.com/apis/admin/v1 description: Superhuman Docs Admin API (v1) security: - Bearer: [] tags: - name: Folders description: 'Folders contain docs and enable folder members to access those docs. ' paths: /organizations/{organizationId}/workspaces/{workspaceId}/folders: get: summary: List folders description: 'Returns a list of folders in the workspace ' operationId: listFolders tags: - Folders parameters: - $ref: '#/components/parameters/organizationId' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/folderIds' - $ref: '#/components/parameters/folderType' - $ref: '#/components/parameters/query' - name: includeAcl description: Include permissions metadata on each folder. in: query required: false schema: type: boolean description: When true, permissions metadata is included - name: includeDeleted description: Include deleted folders in: query required: false schema: type: boolean description: When true, deleted folders are included responses: '200': description: List of Superhuman Docs folders. content: application/json: schema: $ref: '#/components/schemas/FolderList' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = ''https://docs.superhuman.com/apis/admin/v1/organizations//workspaces/folders'' res = requests.get(uri, headers=headers).json() print(f''First folder is: {res["items"][0]["name"]}'') ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n 'https://docs.superhuman.com/apis/admin/v1/organizations//workspaces//folders' |\n jq .items[0].name\n" /organizations/{organizationId}/workspaces/{workspaceId}/folders/{folderId}: get: summary: Get folder description: 'Returns the requested folder. ' operationId: getFolder tags: - Folders parameters: - $ref: '#/components/parameters/organizationId' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/folderId' responses: '200': description: The requested Superhuman Docs folder. content: application/json: schema: $ref: '#/components/schemas/Folder' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = ''https://docs.superhuman.com/apis/admin/v1/organizations//workspaces//folders/'' res = requests.get(uri, headers=headers).json() print(f''Folder name is: {res["name"]}'') ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n 'https://docs.superhuman.com/apis/admin/v1/organizations//workspaces//folders/' |\n jq .name\n" delete: summary: Delete folder description: 'Deletes the specified folder. The folder must be empty (contain no documents). Personal folders cannot be deleted. ' operationId: deleteFolder tags: - Folders parameters: - $ref: '#/components/parameters/organizationId' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/folderId' responses: '200': description: Confirmation that the folder was deleted. content: application/json: schema: $ref: '#/components/schemas/DeleteFolderResult' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = ''https://docs.superhuman.com/apis/admin/v1/organizations//workspaces//folders/'' res = requests.delete(uri, headers=headers) print(''Folder deleted successfully'') ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' -X DELETE \\\n 'https://docs.superhuman.com/apis/admin/v1/organizations//workspaces//folders/'\n# => Folder deleted successfully\n" /folders: get: summary: List folders description: 'Returns a list of folders the user has access to. ' operationId: listFolders tags: - Folders parameters: - name: workspaceId in: query description: Show only folders belonging to the given workspace. schema: type: string example: ws-1Ab234 - name: isStarred in: query description: If true, returns folders that are starred. If false, returns folders that are not starred. If not specified, returns all folders. schema: type: boolean - $ref: '#/components/parameters/limit_2' - $ref: '#/components/parameters/pageToken' responses: '200': description: List of folders. content: application/json: schema: $ref: '#/components/schemas/FolderList_2' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: "import requests\n\nheaders = {'Authorization': 'Bearer '}\nuri = 'https://docs.superhuman.com/apis/v1/folders'\nres = requests.get(uri, headers=headers).json()\n\nfor folder in res['items']:\n print(f'Folder: {folder[\"name\"]}')\n" - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n 'https://docs.superhuman.com/apis/v1/folders' |\n jq '.items[].name'\n" post: summary: Create folder description: 'Creates a new folder. ' operationId: createFolder tags: - Folders requestBody: description: Parameters for creating the folder. required: true content: application/json: schema: $ref: '#/components/schemas/CreateFolderRequest' responses: '201': description: The created folder. content: application/json: schema: $ref: '#/components/schemas/Folder_2' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = ''https://docs.superhuman.com/apis/v1/folders'' payload = {''name'': ''My New Folder''} res = requests.post(uri, headers=headers, json=payload).json() print(f''Created folder: {res["id"]}'') ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"My New Folder\"}' \\\n 'https://docs.superhuman.com/apis/v1/folders' |\n jq .id\n" /folders/{folderId}: get: summary: Get folder description: 'Returns the requested folder. ' operationId: getFolder tags: - Folders parameters: - $ref: '#/components/parameters/folderId_2' responses: '200': description: The requested Superhuman Docs folder. content: application/json: schema: $ref: '#/components/schemas/Folder_2' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = ''https://docs.superhuman.com/apis/v1/folders/'' res = requests.get(uri, headers=headers).json() print(f''Folder name is: {res["name"]}'') ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n 'https://docs.superhuman.com/apis/v1/folders/' |\n jq .name\n" patch: summary: Update folder description: 'Updates metadata for a folder. ' operationId: updateFolder tags: - Folders parameters: - $ref: '#/components/parameters/folderId_2' requestBody: description: Parameters for updating the folder. required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFolderRequest' responses: '200': description: The updated folder. content: application/json: schema: $ref: '#/components/schemas/Folder_2' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = ''https://docs.superhuman.com/apis/v1/folders/'' payload = {''name'': ''Updated Folder Name''} res = requests.patch(uri, headers=headers, json=payload).json() print(f''Updated folder: {res["name"]}'') ' - label: Shell lang: shell source: "curl -s -X PATCH -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -d '{\"name\": \"Updated Folder Name\"}' \\\n 'https://docs.superhuman.com/apis/v1/folders/' |\n jq .name\n" delete: summary: Delete folder description: 'Deletes a folder. The folder must be empty (contain no docs). ' operationId: deleteFolder tags: - Folders parameters: - $ref: '#/components/parameters/folderId_2' responses: '200': description: Folder was successfully deleted. content: application/json: schema: $ref: '#/components/schemas/DeleteFolderResult_2' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = ''https://docs.superhuman.com/apis/v1/folders/'' res = requests.delete(uri, headers=headers) print(f''Deleted: {res.status_code == 200}'') ' - label: Shell lang: shell source: "curl -s -X DELETE -H 'Authorization: Bearer ' \\\n 'https://docs.superhuman.com/apis/v1/folders/'\n" components: schemas: UpdateFolderRequest: x-schema-name: UpdateFolderRequest description: Request for updating a folder. type: object additionalProperties: false properties: name: type: string description: Name of the folder. example: Projects description: type: string description: Description of the folder. example: A collection of project docs. Folder_2: x-schema-name: Folder description: A Superhuman Docs folder. type: object required: - id - type - name - browserLink - workspace additionalProperties: false properties: id: type: string description: ID of the Superhuman Docs folder. example: fl-1Ab234 type: type: string description: The type of this resource. enum: - folder x-tsType: Type.Folder name: type: string description: The name of the folder. example: Projects browserLink: type: string format: url description: Browser-friendly link to the folder. example: https://docs.superhuman.com/folders/fl-1Ab234 description: type: string description: The description of the folder. example: A collection of project docs. icon: $ref: '#/components/schemas/Icon' createdAt: type: string format: date-time description: Timestamp for when the folder was created. example: '2018-04-11T00:18:57.946Z' canEdit: type: boolean description: Whether the folder settings can be edited. E.g., some folder types (like personal folders - "My Docs") cannot be edited. example: true workspace: $ref: '#/components/schemas/WorkspaceReference' FolderList: x-schema-name: FolderList description: List of folders. type: object required: - items - href additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/Folder' href: type: string format: url description: API link to these results example: https://docs.superhuman.com/apis/admin/v1/organizations//workspaces//folders nextPageToken: $ref: '#/components/schemas/NextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/NextPageLink' - type: string example: https://docs.superhuman.com/apis/admin/v1/organizations//workspaces//folders?pageToken=eyJsaW1pd Folder: x-schema-name: Folder description: Info about a Superhuman Docs folder. type: object required: - type - id - name - folderType additionalProperties: false properties: type: type: string description: The type of this resource. enum: - folder x-tsType: Type.Folder id: type: string description: ID of the Superhuman Docs folder. example: fl-1Ab234 name: type: string description: Name of the Superhuman Docs folder. example: My docs icon: type: string description: Name of the Superhuman Docs folder icon. example: exclamation-circle-filled description: type: string description: Description of the Superhuman Docs folder. example: This folder holds my important docs. folderType: $ref: '#/components/schemas/FolderType' isPrivate: deprecated: true type: boolean description: Deprecated, use folder permissions instead. acl: type: array items: $ref: '#/components/schemas/FolderPermission' truncatedAcl: type: boolean description: True if the inline ACL field was truncated; use a paginated ACL query to fetch all permissions. WorkspaceReference: x-schema-name: WorkspaceReference description: Reference to a Superhuman Docs workspace. type: object required: - id - type - browserLink additionalProperties: false properties: id: type: string description: ID of the Superhuman Docs workspace. example: ws-1Ab234 type: type: string description: The type of this resource. enum: - workspace x-tsType: Type.Workspace organizationId: type: string description: ID of the organization bound to this workspace, if any. example: org-2Bc456 browserLink: type: string format: url description: Browser-friendly link to the Superhuman Docs workspace. example: https://docs.superhuman.com/docs?workspaceId=ws-1Ab234 name: type: string description: Name of the workspace; included if the user has access to the workspace. example: My workspace CreateFolderRequest: x-schema-name: CreateFolderRequest description: Request for creating a folder. type: object required: - name - workspaceId additionalProperties: false properties: name: type: string description: Name of the folder. example: Projects workspaceId: type: string description: ID of the workspace where the folder should be created. example: ws-1Ab234 description: type: string description: Description of the folder. example: A collection of project docs. DomainPrincipal: type: object required: - domain - type additionalProperties: false properties: type: type: string description: The type of this principal. enum: - domain x-tsType: PrincipalType.Domain domain: type: string description: Domain for the principal. example: domain.com FolderList_2: x-schema-name: FolderList description: List of folders. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/Folder_2' href: type: string format: url description: API link to these results. example: https://docs.superhuman.com/apis/v1/folders?workspaceId=ws-1Ab234 nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://docs.superhuman.com/apis/v1/folders?pageToken=xyz EmailPrincipal: type: object required: - email - type additionalProperties: false properties: type: type: string description: The type of this principal. enum: - email x-tsType: PrincipalType.Email email: type: string description: Email for the principal. example: example@domain.com nextPageToken: description: If specified, an opaque token used to fetch the next page of results. type: string example: eyJsaW1pd AnyonePrincipal: type: object required: - type additionalProperties: false properties: type: type: string description: The type of this principal. enum: - anyone x-tsType: PrincipalType.Anyone Principal: x-schema-name: Principal description: Metadata about a principal. oneOf: - $ref: '#/components/schemas/EmailPrincipal' - $ref: '#/components/schemas/GroupPrincipal' - $ref: '#/components/schemas/DomainPrincipal' - $ref: '#/components/schemas/WorkspacePrincipal' - $ref: '#/components/schemas/AnyonePrincipal' discriminator: propertyName: type mapping: email: '#/components/schemas/EmailPrincipal' group: '#/components/schemas/GroupPrincipal' domain: '#/components/schemas/DomainPrincipal' workspace: '#/components/schemas/WorkspacePrincipal' anyone: '#/components/schemas/AnyonePrincipal' Icon: x-schema-name: icon description: Info about the icon. type: object required: - name - type - browserLink additionalProperties: false properties: name: type: string description: Name of the icon. type: type: string description: MIME type of the icon browserLink: type: string format: url description: Browser-friendly link to an icon. example: https://cdn.coda.io/icons/png/color/icon-32.png NextPageToken: description: If specified, an opaque token used to fetch the next page of results. type: string example: eyJsaW1pd GroupPrincipal: type: object required: - groupId - groupName - type additionalProperties: false properties: type: type: string description: The type of this principal. enum: - group x-tsType: PrincipalType.Group groupId: type: string description: Group ID for the principal. example: grp-6SM9xrKcqW groupName: type: string description: Name of the group. example: Marketing team DeleteFolderResult_2: x-schema-name: DeleteFolderResult description: The result of a folder deletion. type: object additionalProperties: false nextPageLink: description: If specified, a link that can be used to fetch the next page of results. type: string format: url FolderAccessType: x-schema-name: FolderAccessType description: Type of access for folders only. type: string enum: - readonly - write - comment - manage - none x-tsEnumNames: - ReadOnly - Write - Comment - Manage - None WorkspacePrincipal: type: object required: - type - workspaceId additionalProperties: false properties: type: type: string description: The type of this principal. enum: - workspace x-tsType: PrincipalType.Workspace workspaceId: type: string description: WorkspaceId for the principal. example: ws-sdfmsdf9 FolderType: x-schema-name: FolderType type: string enum: - Standard - Personal x-tsEnumNames: - Standard - Personal DeleteFolderResult: x-schema-name: DeleteFolderResult description: The result of deleting a folder. type: object additionalProperties: false properties: {} NextPageLink: description: If specified, a link that can be used to fetch the next page of results. type: string format: url FolderPermission: x-schema-name: FolderPermission description: A specific folder permission granted to a principal. type: object required: - type - principal - id - access additionalProperties: false properties: type: type: string description: The type of this resource. enum: - permission x-tsType: Type.Permission principal: $ref: '#/components/schemas/Principal' id: type: string description: ID for the Permission access: $ref: '#/components/schemas/FolderAccessType' responses: ForbiddenError: description: The API token does not grant access to this resource. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 403 statusMessage: type: string description: HTTP status message of the error. example: Forbidden message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Forbidden NotFoundError: description: The resource could not be located with the current API token. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 404 statusMessage: type: string description: HTTP status message of the error. example: Not Found message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Not Found TooManyRequestsError: description: The client has sent too many requests. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 429 statusMessage: type: string description: HTTP status message of the error. example: Too Many Requests message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Too Many Requests UnauthorizedError: description: The API token is invalid or has expired. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 401 statusMessage: type: string description: HTTP status message of the error. example: Unauthorized message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Unauthorized BadRequestError: description: The request parameters did not conform to expectations. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 400 statusMessage: type: string description: HTTP status message of the error. example: Bad Request message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Bad Request parameters: workspaceId: name: workspaceId description: ID of the workspace. in: path required: true example: ws-AbCDeFGHIj schema: type: string folderIds: name: folderIds description: Comma-separated list of folder IDs in: query explode: false example: - fl-AbCDeFGHIj schema: type: array items: type: string limit_2: name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 organizationId: name: organizationId description: ID of the organization. in: path required: true example: org-AbCDeFGHIj schema: type: string query: name: query description: Search terms used to narrow down results. in: query required: false example: feature%parity schema: type: string pageToken: name: pageToken description: An opaque token used to fetch the next page of results. in: query example: eyJsaW1pd schema: type: string folderId: name: folderId description: ID of the folder. in: path required: true example: fl-AbCDeFGHIj schema: type: string limit: name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 100 maximum: 500 folderId_2: name: folderId description: ID of the folder. in: path required: true example: fl-1Ab234 schema: type: string folderType: name: folderType description: Type of the folder in: query example: Standard schema: $ref: '#/components/schemas/FolderType' securitySchemes: Bearer: description: 'The Superhuman Docs Admin API can be accessed using an API token, which can be obtained from [*My account*](https://docs.superhuman.com/account) in Superhuman Docs. This token should be specified by setting a header as follows. ```Authorization: Bearer ``` Keep your token safe, as anyone who gets access to it can access your account. Once a token is created it cannot be viewed or modified, so don''t lose it. ' type: http scheme: bearer bearerFormat: UUID x-tagGroups: - name: API Tokens tags: - API Tokens - name: Docs tags: - Docs - Doc Permissions - Doc Export - name: Doc Structure tags: - Pages - name: Events tags: - Events - name: Folders tags: - Folders - Folder Permissions - name: Groups tags: - Groups - name: Import tags: - Preferences - name: LegalHolds tags: - LegalHolds - name: Organizations tags: - Organizations - Organization Users - Pack Controls - Pack Configurations - name: Packs tags: - Packs - name: Webhooks tags: - Webhooks - name: Workspaces tags: - Workspaces - Workspace Users