Skip to main content
GET
Get an agent folder

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Path Parameters

folder_id
string
required

Response

The folder.

A folder the org sorts its agents into, as the console’s Agents page and sidebar show them. Folders go inside one another (up to 20 deep); names are unique among a folder’s own folders, whatever the capitals. An agent is in one folder or none (folder_id on the agent).

object
any
required
id
string
required
Example:

"fld_3kq9Zp1xV2"

name
string
required
Maximum string length: 80
Example:

"EMEA"

parent_id
string | null
required

The folder it’s in; null at the top.

path
string[]
required

The names of its folders from the top down to it, itself last.

Example:
agents
integer
required

How many agents are directly in it.

folders
integer
required

How many folders are directly in it.

created_at
string<date-time>
updated_at
string<date-time>
created_by
Person · object

Who did it: a person (in the console) or an API key. Null when nobody was recorded: it was made with a session token, by Eager itself, or before this was kept.