Skip to main content
GET
List Vault Projects and Knowledge Bases

Permissions

Requires View workspace projects permission.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Page number for pagination (default: 1)

Required range: x >= 1
per_page
integer
default:20

Number of items per page (default: 20, max: 100)

Required range: 1 <= x <= 100
name
string

Case-insensitive substring match on project name.

Maximum string length: 256
is_knowledge_base
boolean

Filter by knowledge base flag. true returns only knowledge base projects, false excludes them, and omitting the parameter returns both.

created_after
integer<int64>

Inclusive lower bound on project creation time, expressed as a UTC Unix epoch timestamp in seconds. Only projects with created_at >= created_after are returned. Must be strictly less than created_before when both are provided.

created_before
integer<int64>

Exclusive upper bound on project creation time, expressed as a UTC Unix epoch timestamp in seconds. Only projects with created_at < created_before are returned.

sort_by
enum<string>
default:date

Field to sort the results by. date sorts by the project's last content-update timestamp (the default ordering). name sorts alphabetically by project name.

Available options:
date,
name
sort_order
enum<string>
default:desc

Sort direction to order results list.

Available options:
asc,
desc

Response

Successfully retrieved workspace projects

response
object