Skip to main content
GET
List Organization Folders
Read only List organization folders to resolve the folder IDs and names available in the authenticated workspace. The operation returns active folders only and sorts them from oldest to newest.

When to list organization folders

  • Resolve a folder ID before filtering or organizing agents.
  • Build a folder picker without hard-coding workspace-specific IDs.
  • Confirm that a folder exists before reading its details.

Query parameters

Verify the result

Use the folders array to read each folder’s id and name. Each folder also carries organization_id, is_deleted, createdAt, updatedAt, an organization object with id and title, and agentCount, the number of agents in the folder that are not deleted. agentCount is returned by this list only, not by Get Organization Folder. The response also includes the applied page and limit values; results are always paginated, so request further pages until one comes back short. An empty folders array means no active folder matched the request.

Errors and recovery

  • 401 Unauthorized means the API key is missing or invalid.
  • 404 Not Found means the authenticated organization no longer exists.
  • 400 Bad Request means page or limit does not start with a number or is outside the supported range (a value such as 2.5 or 5abc is read as its leading whole number), for example Limit must be between 1 and 50. Correct the query before retrying.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

Search by folder name

Example:

"Call"

page
string
default:1

Page number, starting from 1. Default 1. Read with parseInt, so 2.5 or 2abc is page 2; a value that does not start with a number, or is below 1, returns 400.

Example:

"1"

limit
string
default:20

Folders per page, from 1 to 50. Default 20. Read with parseInt, so 10.5 is 10; a value that does not start with a number, or is outside 1 to 50, returns 400.

Example:

"20"

export
boolean
default:false

Accepted for compatibility but ignored: results are always paginated.

Example:

true

Response

Organization folders returned successfully.

success
enum<boolean>
required
Available options:
true
error
enum<boolean>
required
Available options:
false
statusCode
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required
timestamp
string<date-time>
required