/v1/resources/getResources
—
post
Path Parameters
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Request Body
GetResourcesEndpointParams

Parameters for fetching multiple resources in a single request. This allows batch operations for better performance.

{
workspaceId?: string
resources: Array<FetchResourceItem>
}
FetchResourceItem

Specifies how to fetch a specific resource. You can identify resources by ID, filepath, or folderpath, combined with the action you want to perform.

{
resourceId?: string | Array<string>
action: string
filepath?: string | Array<string>
folderpath?: string | Array<string>
workspaceRootname?: string
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
GetResourcesEndpointResult

Response containing the requested resources. Each resource is wrapped with metadata for easy identification.

{
resources: Array<ResourceWrapper>
}
ResourceWrapper

Wraps a resource with metadata about its type and ID. This provides context about what kind of resource is being returned.

{
resourceId: string
resourceType: string
resource: Resource
}
Resource

The actual resource data. The structure varies depending on the resource type (file, folder, workspace, etc.).

{
resourceId: string
createdBy?: Agent
createdAt: number
lastUpdatedBy?: Agent
lastUpdatedAt: number
isDeleted: boolean
deletedAt?: number
deletedBy?: Agent
}
Agent

Represents a user or system entity that performed an action (e.g., created or updated a resource)

{
agentId: string
agentType: string
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}