AI13

AI Credit Controls6

AI Credit Usage2

AI Eval12

AI Model Suggestions9

AI Routines6

API Tokens4

App downloads3

Apps8

Branches3

Color Palettes5

Connection environments3

Connections5

Content2

Content migration2

Content validator2

Dashboard downloads3

Dashboard filters2

dbt9

Document favorites3

Document labels3

Document permissions6

Documents16

Documents v27

Embed1

Folder favorites2

Folder labels1

Folder permissions5

Folders5

IP Allowlist2

Jobs1

Labels5

Model branches1

Model Git configuration7

Models17

Queries3

Schedule recipients6

Schedules10

Schema refresh schedules5

Skills5

Topics4

Uploads4

User attributes9

User group model roles2

User groups6

User model roles2

Users10

Who Am I1

Folders

List folders

Changed on Nov 3, 2026

Retrieve a paginated list of folders within an organization. Supports filtering, sorting, and cursor-based pagination.

The folders endpoint behaves differently based on the type of API key used to authenticate the request:

Organization-scoped API keys: Full access to all folders. Can view any user's restricted folders with ownerId. Must provide ownerId for scope=restricted.
Personal Access Tokens (PAT): Permission-filtered access matching the UI.
- For scope=organization - Returns all organization-shared folders the user can access
- For scope=restricted - Returns only the user's own restricted folders. An ownerId is optional; if not provided, it will be auto-inferred and the API will return only the folders belonging to PAT owner.

get/v1/folders

Request

Base URL
https://blobsrus.omniapp.co/api
URL
https://blobsrus.omniapp.co/api/v1/folders
Auth
HTTP bearer

Query parameters

includestring

Comma-separated list of additional fields to include:

_count - Include document and favorite counts
labels - Include folder labels
onlyFavorites - Returns only folders the user has favorited and can still access. Cannot be combined with onlySharedWithMe, ownerId, or path.
onlySharedWithMe - Returns only folders explicitly shared with the specified user via folder permissions. Excludes folders owned by the user. Cannot be combined with onlyFavorites, ownerId, or path.

Additionally, depending on the type of API key being used:
- Organization API keys require the userId parameter
- Personal Access Tokens automatically infer the userId from the token

pathstring

Filter folders by path. Wildcards are supported and must appear at the end of the path:

* - Include direct children only (e.g., blob-sales/*)
** - Include all descendants recursively (e.g., blob-sales/**)

labelsstring[]

Comma-separated list of labels to filter by.

scope'organization' | 'restricted'

Scope of folders to retrieve.

When include=onlySharedWithMe or include=onlyFavorites is specified without a scope parameter, returns results of all scopes with each folder's actual scope preserved
Otherwise, defaults to organization

When set to restricted, the ownerId parameter behavior depends on the API key type:

Organization-scoped API keys: ownerId is required
Personal Access Tokens (PAT): ownerId is optional and auto-inferred to the token owner

sortField'favorites' | 'name' | 'path'

Field to sort by:

favorites - Sort by number of favorites
name - Sort by folder name
path - Sort by folder path

sortDirection'asc' | 'desc'

Sort direction.

cursorstring

Cursor for pagination positioning.

pageSizeinteger

Number of items per page.

ownerIdstring uuid

UUID of organization membership.

How the API behaves depends on the type of API key used to authenticate the request and the current scope value.

Personal Access Tokens (PAT)

Scope	ownerId	Behavior
organization	Not provided	All organization-shared folders user has permission to access
organization	own ID	Own organization folders only
restricted	Not provided	Infers owner's ID, returns own restricted folders
restricted	Own ID	Own restricted folders
restricted	Other's ID	403 Forbidden

Organization API key

Scope	ownerId	Behavior
organization	Not provided	All organization folders
organization	Any ID	That user's organization folders
restricted	Not provided	400 Bad Request (ownerId required)
restricted	Any ID	That user's restricted folders

userIdstring uuid

Membership ID of the user whose folders to return. Only used with include=onlyFavorites or include=onlySharedWithMe.

Required when using an Organization API key with either flag. Automatically inferred from the token when using a Personal Access Token.

Response

Paginated folder list

Example response

{
  "records": [
    {
      "name": "My Reports",
      "url": "https://blobsrus.omni.co/f/blob-sales-reports"
    }
  ]
}

Changes

Nov 3, 202643290040f88f Revision changes
- breaking
  added the pattern ^\s*((_count|labels|onlyFavorites|onlySharedWithMe)\s*)?(,\s*((_count|labels|onlyFavorites|onlySharedWithMe)\s*)?)*$ to the query request parameter include
- breaking
  the // response's property format changed from uuid to no format for status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status

Operation history