API ReferenceProjects

Get Projects by Team

Fetch a paginated list of all Projects belonging to a Team

Authentication

AuthorizationBearer

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

Path parameters

team_idstringRequiredformat: "uuid"

Query parameters

filter[archived]stringOptional

Add this query param with the value all to return both archived and non-archived projects

Response headers

page-numberinteger
Current page of results
per-pageinteger
Number of entries per page
totalinteger
Total entries across all pagess
total-pagesinteger
Number of pages

Response

Paginated projects success response
archive_statusenumOptional
Archival status for this Project
archived_atstringOptionalformat: "date-time"
When a Project was archived
archived_file_countintegerOptionalDefaults to 0
archived_storageintegerOptionalDefaults to 0
collaborator_countintegerOptionalDefaults to 0
deleted_atstringOptionalformat: "date-time"
If deleted, when this Project was deleted
descriptionstringOptional
file_countintegerOptionalDefaults to 0
folder_countintegerOptionalDefaults to 0
idstringOptionalformat: "uuid"
ignore_archivebooleanOptionalDefaults to false
inserted_atstringOptionalformat: "date-time"
When was this Project created
invite_urlstringOptional
namestringOptional
Name of this Project
owner_idstringOptionalformat: "uuid"
privatebooleanOptionalDefaults to false
project_preferencesobjectOptional
read_onlybooleanOptionalDefaults to false
root_assetobjectOptional

Accepts arbitrary key/value pairs for storing information on an asset

root_asset_idstringOptionalformat: "uuid"
sharedbooleanOptionalDefaults to false
storageintegerOptionalDefaults to 0
teamobjectOptional
team_idstringOptionalformat: "uuid"
updated_atstringOptionalformat: "date-time"
user_permissionsobjectOptional
user_preferencesobjectOptional
watermarkobjectOptional

Errors

401
Unauthorized Error
404
Not Found Error