Port Folders API
The Folders API from Port — 2 operation(s) for folders.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/port-io:port-io-folders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Port Folders API
version: '1.0'
tags:
- name: Folders
paths:
/v1/sidebars/{sidebar_identifier}/folders:
post:
summary: Create a folder
tags:
- Folders
description: 'This route allows you to create a folder in a sidebar. Folders let you organize pages in your platform''s navigation.
To learn more about folders, check out the documentation.'
requestBody:
content:
application/json:
schema:
type: object
properties:
identifier:
type: string
pattern: ^[A-Za-z0-9@_=\\-]+$
minLength: 1
description: The unique identifier of the folder.
title:
type: string
description: The display title of the folder.
icon:
type: string
description: The display icon of the folder.
nullable: true
parent:
type: string
nullable: true
description: The identifier of the parent folder. Use `null` to place the folder at the root level of the sidebar.
after:
type: string
nullable: true
description: The identifier of the sibling item after which this folder should appear. Use `null` to place the folder at the beginning of its parent.
additionalProperties: false
required:
- identifier
- title
required: true
parameters:
- schema:
type: string
enum:
- catalog
in: path
name: sidebar_identifier
required: true
description: The identifier of the sidebar. Currently only `catalog` is supported.
security:
- bearer:
- create:pages
x-should-be-exposed-to-customers: true
responses:
'201':
description: Created successfully.
content:
application/json:
schema:
description: Created successfully.
type: object
properties:
ok:
enum:
- true
folder:
type: object
properties:
identifier:
type: string
description: The unique identifier of the folder.
title:
type: string
description: The display title of the folder.
icon:
type: string
nullable: true
description: The display icon of the folder.
sidebar:
type: string
description: The identifier of the sidebar that contains the folder.
parent:
type: string
nullable: true
description: The identifier of the parent folder. Omitted when the folder is at the root level of the sidebar.
after:
type: string
nullable: true
description: The identifier of the sibling item after which this folder appears. Omitted when the folder is the first item in its parent.
updatedBy:
type: string
createdBy:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- identifier
- title
- sidebar
- createdBy
- updatedBy
- createdAt
- updatedAt
additionalProperties: false
required:
- folder
- ok
additionalProperties: false
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
operationId: postV1SidebarsBySidebarIdentifierFolders
x-operation-id-source: derived
/v1/sidebars/{sidebar_identifier}/folders/{folder_identifier}:
patch:
summary: Update a folder
tags:
- Folders
description: 'This route allows you to update a folder in a sidebar. You can change its title, identifier, or position within the sidebar hierarchy.
To learn more about folders, check out the documentation.'
requestBody:
content:
application/json:
schema:
type: object
properties:
identifier:
type: string
pattern: ^[A-Za-z0-9@_=\\-]+$
minLength: 1
description: The unique identifier of the folder.
title:
type: string
description: The display title of the folder.
icon:
type: string
description: The display icon of the folder.
nullable: true
parent:
type: string
nullable: true
description: The identifier of the parent folder. Use `null` to place the folder at the root level of the sidebar.
after:
type: string
nullable: true
description: The identifier of the sibling item after which this folder should appear. Use `null` to place the folder at the beginning of its parent.
additionalProperties: false
parameters:
- schema:
type: string
enum:
- catalog
in: path
name: sidebar_identifier
required: true
description: The identifier of the sidebar. Currently only `catalog` is supported.
- schema:
type: string
minLength: 1
in: path
name: folder_identifier
required: true
description: The identifier of the folder to operate on.
security:
- bearer:
- update:pages
x-should-be-exposed-to-customers: true
responses:
'200':
description: Updated successfully.
content:
application/json:
schema:
description: Updated successfully.
type: object
properties:
ok:
enum:
- true
folder:
type: object
properties:
identifier:
type: string
description: The unique identifier of the folder.
title:
type: string
description: The display title of the folder.
icon:
type: string
nullable: true
description: The display icon of the folder.
sidebar:
type: string
description: The identifier of the sidebar that contains the folder.
parent:
type: string
nullable: true
description: The identifier of the parent folder. Omitted when the folder is at the root level of the sidebar.
after:
type: string
nullable: true
description: The identifier of the sibling item after which this folder appears. Omitted when the folder is the first item in its parent.
updatedBy:
type: string
createdBy:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- identifier
- title
- sidebar
- createdBy
- updatedBy
- createdAt
- updatedAt
additionalProperties: false
required:
- folder
- ok
additionalProperties: false
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
operationId: patchV1SidebarsBySidebarIdentifierFoldersByFolderIdentifier
x-operation-id-source: derived
delete:
summary: Delete a folder
tags:
- Folders
description: 'This route allows you to delete a folder from a sidebar. Deleting a folder also deletes all pages and sub-folders it contains.
To learn more about folders, check out the documentation.'
parameters:
- schema:
type: string
enum:
- catalog
in: path
name: sidebar_identifier
required: true
description: The identifier of the sidebar. Currently only `catalog` is supported.
- schema:
type: string
minLength: 1
in: path
name: folder_identifier
required: true
description: The identifier of the folder to operate on.
security:
- bearer:
- delete:pages
x-should-be-exposed-to-customers: true
responses:
'200':
description: Deleted successfully.
content:
application/json:
schema:
description: Deleted successfully.
type: object
properties:
ok:
type: boolean
description: Whether the folder was deleted successfully.
required:
- ok
additionalProperties: false
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
operationId: deleteV1SidebarsBySidebarIdentifierFoldersByFolderIdentifier
x-operation-id-source: derived
components:
securitySchemes:
bearer:
type: apiKey
name: Authorization
in: header
x-provenance:
method: harvested
publisher: Port
source: https://api.port.io/swagger/json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)