Folders

List folder types

GET/folder-types
documents:readlist_folder_typesRead-only

Lists the folder types the platform holds, ordered by value, and returns one page. A folder's type_id is the id of one of these. Needs only the documents:read scope. Use GET /folder-types/{id} for one type. It changes nothing.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • sortstring#

    Comma-separated fields to sort by: value. Prefix a field with - for descending. Defaults to value. The id is always the final tiebreak.

  • filter[value]string#

    Types with this value, such as deal. Takes [in], [not_in] and [contains].

Responses

200

The folder types.

FolderType[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "value": "string",
      "label": "string"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/folder-types\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"