Get folder details
Folder
Get folder details
Retrieve complete folder information including name, color, short link count, and creation date.
GET
Get folder details
Authorizations
API Key authentication for programmatic access.
How to use:
- Create an API key from your dashboard settings
- Include the key in the
x-api-keyheader with each request - API keys have granular permissions (domains, shortLinks, files, stats, apiKeys)
Example:
Types of API keys:
- User keys: Linked to your user account (one per organization)
- Bot keys: Autonomous machine users (one per organization)
Security notes:
- Keep your API keys secure and never commit them to version control
- API keys cannot access authentication endpoints (/auth/*)
- Keys can be revoked at any time from the dashboard
Path Parameters
Unique identifier in UUID v7 format
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Response
Folder successfully retrieved
Complete folder object
Folder UUID
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Organization UUID
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Folder name
Required string length:
1 - 30Example:
"Marketing Campaign 2024"
Folder color (hex)
Pattern:
^#[0-9A-Fa-f]{6}$Example:
"#3B82F6"
Whether this is the default "Links" folder
Example:
false
Creation timestamp
Example:
"2024-01-15T10:30:00Z"
Last update timestamp
Example:
"2024-01-16T14:20:00Z"