Skip to main content

Fetch folders

Get folders of a specific context (productId and consumerId).

Query Parameters
productId uuid
consumerId uuid
providerId uuid
categoryId uuid
Header Parameters
organization-id uuid REQUIRED

ID of organization context this request belongs to.

Responses
200

The folder(s).

Schema OPTIONAL
folders object[] OPTIONAL
description string OPTIONAL
files uuid[] OPTIONAL
id uuid OPTIONAL
name string OPTIONAL
permissions object[] OPTIONAL
group string OPTIONAL

Possible values: [ACCESS, ACCESS_DEFINITION, CONTACT, ORGANIZATION, PRODUCT, PLAN, CONNECTED_PRODUCT, USER, FILE, TECHNICAL_USER, CONSUMER, INVITATION, USER_ROLES, TEAM, PLATFORM_ADMIN, BUNDLE, FOLDER]

permissions object[] OPTIONAL
group string OPTIONAL

Possible values: [ACCESS, ACCESS_DEFINITION, CONTACT, ORGANIZATION, PRODUCT, PLAN, CONNECTED_PRODUCT, USER, FILE, TECHNICAL_USER, CONSUMER, INVITATION, USER_ROLES, TEAM, PLATFORM_ADMIN, BUNDLE, FOLDER]

400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL