Dub Folders API
The Folders API from Dub — 2 operation(s) for folders.
OpenAPI Specification
openapi: 3.0.3
info:
title: Dub Analytics Folders API
description: Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs.
version: 0.0.1
contact:
name: Dub Support
email: support@dub.co
url: https://dub.co/support
license:
name: AGPL-3.0 license
url: https://github.com/dubinc/dub/blob/main/LICENSE.md
servers:
- url: https://api.dub.co
description: Production API
tags:
- name: Folders
paths:
/folders:
post:
operationId: createFolder
x-speakeasy-name-override: create
summary: Create a folder
description: Create a folder for the authenticated workspace.
tags:
- Folders
security:
- token: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
maxLength: 190
description: The name of the folder.
description:
description: The description of the folder.
nullable: true
type: string
maxLength: 500
accessLevel:
default: null
description: The access level of the folder within the workspace.
nullable: true
type: string
enum:
- write
- read
required:
- name
responses:
'201':
description: The created folder
content:
application/json:
schema:
$ref: '#/components/schemas/FolderSchema'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
get:
operationId: listFolders
x-speakeasy-name-override: list
summary: List all folders
description: Retrieve a paginated list of folders for the authenticated workspace.
tags:
- Folders
security:
- token: []
parameters:
- in: query
name: search
schema:
description: The search term to filter the folders by.
type: string
description: The search term to filter the folders by.
- in: query
name: page
schema:
description: The page number for pagination.
example: 1
deprecated: false
type: number
minimum: 0
exclusiveMinimum: true
description: The page number for pagination.
- in: query
name: pageSize
schema:
default: 50
description: The number of items per page.
example: 50
type: number
minimum: 0
exclusiveMinimum: true
maximum: 50
description: The number of items per page.
responses:
'200':
description: A list of folders
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FolderSchema'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
/folders/{id}:
patch:
operationId: updateFolder
x-speakeasy-name-override: update
x-speakeasy-max-method-params: 2
summary: Update a folder
description: Update a folder in the workspace.
tags:
- Folders
security:
- token: []
parameters:
- in: path
name: id
schema:
type: string
description: The ID of the folder to update.
required: true
description: The ID of the folder to update.
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
maxLength: 190
description: The name of the folder.
description:
description: The description of the folder.
nullable: true
type: string
maxLength: 500
accessLevel:
description: The access level of the folder within the workspace.
nullable: true
type: string
enum:
- write
- read
responses:
'200':
description: The updated folder.
content:
application/json:
schema:
$ref: '#/components/schemas/FolderSchema'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
delete:
operationId: deleteFolder
x-speakeasy-name-override: delete
x-speakeasy-max-method-params: 1
summary: Delete a folder
description: Delete a folder from the workspace. All existing links will still work, but they will no longer be associated with this folder.
tags:
- Folders
security:
- token: []
parameters:
- in: path
name: id
schema:
type: string
description: The ID of the folder to delete.
required: true
description: The ID of the folder to delete.
responses:
'200':
description: The deleted folder ID.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the deleted folder.
required:
- id
additionalProperties: false
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
components:
responses:
'500':
description: The server has encountered a situation it does not know how to handle.
content:
application/json:
schema:
x-speakeasy-name-override: InternalServerError
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- internal_server_error
description: A short code indicating the error code returned.
example: internal_server_error
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#internal-server_error
required:
- code
- message
required:
- error
'429':
description: The user has sent too many requests in a given amount of time ("rate limiting")
content:
application/json:
schema:
x-speakeasy-name-override: RateLimitExceeded
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- rate_limit_exceeded
description: A short code indicating the error code returned.
example: rate_limit_exceeded
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#rate-limit_exceeded
required:
- code
- message
required:
- error
'422':
description: The request was well-formed but was unable to be followed due to semantic errors.
content:
application/json:
schema:
x-speakeasy-name-override: UnprocessableEntity
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- unprocessable_entity
description: A short code indicating the error code returned.
example: unprocessable_entity
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#unprocessable-entity
required:
- code
- message
required:
- error
'403':
description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
content:
application/json:
schema:
x-speakeasy-name-override: Forbidden
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- forbidden
description: A short code indicating the error code returned.
example: forbidden
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#forbidden
required:
- code
- message
required:
- error
'404':
description: The server cannot find the requested resource.
content:
application/json:
schema:
x-speakeasy-name-override: NotFound
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- not_found
description: A short code indicating the error code returned.
example: not_found
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#not-found
required:
- code
- message
required:
- error
'401':
description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
content:
application/json:
schema:
x-speakeasy-name-override: Unauthorized
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- unauthorized
description: A short code indicating the error code returned.
example: unauthorized
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#unauthorized
required:
- code
- message
required:
- error
'400':
description: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
content:
application/json:
schema:
x-speakeasy-name-override: BadRequest
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- bad_request
description: A short code indicating the error code returned.
example: bad_request
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#bad-request
required:
- code
- message
required:
- error
'409':
description: This response is sent when a request conflicts with the current state of the server.
content:
application/json:
schema:
x-speakeasy-name-override: Conflict
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- conflict
description: A short code indicating the error code returned.
example: conflict
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#conflict
required:
- code
- message
required:
- error
'410':
description: This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
content:
application/json:
schema:
x-speakeasy-name-override: InviteExpired
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- invite_expired
description: A short code indicating the error code returned.
example: invite_expired
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://dub.co/docs/api-reference/errors#invite-expired
required:
- code
- message
required:
- error
schemas:
FolderSchema:
type: object
properties:
id:
type: string
description: The unique ID of the folder.
name:
type: string
description: The name of the folder.
description:
nullable: true
description: The description of the folder.
type: string
type:
type: string
enum:
- default
- mega
accessLevel:
default: null
description: The access level of the folder within the workspace.
nullable: true
type: string
enum:
- write
- read
createdAt:
description: The date the folder was created.
type: string
updatedAt:
description: The date the folder was updated.
type: string
required:
- id
- name
- description
- type
- accessLevel
- createdAt
- updatedAt
additionalProperties: false
securitySchemes:
token:
type: http
description: Default authentication mechanism
scheme: bearer
x-speakeasy-example: DUB_API_KEY