resource

list resources

Changed on
get/w/{workspace}/resources/list

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/resources/list
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

resource_typestring

resource_types to list from, separated by ',',

resource_type_excludestring

resource_types to not list from, separated by ',',

path_startstring

filter resources by path prefix

pathstring

exact path match filter

descriptionstring

pattern match filter for description field (case-insensitive)

valuestring

JSONB subset match filter using base64 encoded JSON

broad_filterstring

broad search across multiple fields (case-insensitive substring match)

labelstring

Filter by label

include_draft_onlyboolean

When true, append per-user draft resources whose path has no deployed resource. Synthesized rows carry draft_only: true.

starred_onlyboolean

Only the ai_agent resources the caller starred

Response

resource list

workspace_idstring
pathstring required
descriptionstring
resource_typestring required
valueunknown
is_oauthboolean required
extra_permsobject
is_expiredboolean
refresh_errorstring
is_linkedboolean required
is_refreshedboolean required
accountnumber
created_bystring
edited_atstring date-time
labelsstring[]
inherited_labelsstring[]

Labels inherited from the parent folder, computed at read time. Read-only — edit them on the folder.

ws_specificboolean
draft_onlyboolean

True when this row is a per-user draft with no deployed resource at the same path. Frontend renders a "Draft" badge.

is_draftboolean

True when the authed user has a per-user draft at this path (over a deployed row or a synthesized draft-only row). Frontend appends a * to the displayed name.

agent_memoryunknown
draft_pathstring

On a draft-only row, the path its editor has staged when it differs from the storage path (e.g. a never-deployed item parked at u/{user}/draft_{uuid}).

Changes

  • affe757e9753Revision changes
    • info

      added the new optional query request parameter starred_only

  • a6768398a054Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status