Get all projects

Retrieve a list of all projects for a team

GET

/projects

Authorization

Authorization

header

string

required

Enter the team access token with the Bearer prefix, e.g. "Bearer team_access_token"

Responses

application/json

data

object[]

required

Data contains the project items

asset_defaults

object

required

Defaults for new Assets, including Assets created from Uploads.

created_at

string

date-time

required

Timestamp when the project was created

Examples:

2025-01-01T12:00:00Z

id

string

required

Id is the unique identifier for the project.

Examples:

proj_2vPYfWPSk3Uejm1HHaMoDqogcVJ

name

string

required

Name of the project

Examples:

My Video Project

slug

string

required

Slug is the slug for the project.

Examples:

my-video-project

storage_id

string

required

StorageId identifier where project files are stored

Examples:

stor_chunkify_S1cce6120E56e7Tu9ioP09Nhjk1

default_workflow_id

object

DefaultWorkflowId specifies the default Workflow for new Assets. Set null to clear it.

status

"success"

string

required

Status indicates the response status "success"

Projects retrieved successfully

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error: invalid token or subscription inactive

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Rate limit exceeded

import Chunkify from '@chunkify/chunkify';

const client = new Chunkify({
  teamAccessToken: 'My Team Access Token',
});

const projects = await client.projects.list();

console.log(projects);
from chunkify import Chunkify

client = Chunkify(
    team_access_token="My Team Access Token",
)
projects = client.projects.list()
print(projects)
<?php

use Chunkify\Client;

$client = new Client(
    teamAccessToken: 'My Team Access Token',
);

$projects = $client->projects->list();

var_dump($projects);
package main

import (
  "context"
  "fmt"

  "github.com/chunkifydev/chunkify-go"
  "github.com/chunkifydev/chunkify-go/option"
)

func main() {
  client := chunkify.NewClient(
    option.WithTeamAccessToken("My Team Access Token"),
  )
  projects, err := client.Projects.List(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", projects)
}

{
  "data": [
    {
      "asset_defaults": {},
      "created_at": "2025-01-01T12:00:00Z",
      "id": "proj_2vPYfWPSk3Uejm1HHaMoDqogcVJ",
      "name": "My Video Project",
      "slug": "my-video-project",
      "storage_id": "stor_chunkify_S1cce6120E56e7Tu9ioP09Nhjk1"
    }
  ],
  "status": "success"
}
{
  "error": {
    "code": 401,
    "message": "Authentication error: invalid token or subscription inactive",
    "type": "AuthenticationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "type": "TooManyRequestsError"
  },
  "status": "error"
}

# Get all projects > Retrieve a list of all projects for a team ```json { "path": "/projects", "method": "get", "schema": { "description": "Retrieve a list of all projects for a team", "operationId": "listProjects", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectListResponse" } } }, "description": "Projects retrieved successfully" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorAuthentication" } } }, "description": "Authentication error: invalid token or subscription inactive" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorTooManyRequests" } } }, "description": "Rate limit exceeded" } }, "security": [ { "TeamAccessToken": [] } ], "summary": "Get all projects", "tags": [ "Projects" ], "x-codeSamples": [ { "lang": "JavaScript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n teamAccessToken: 'My Team Access Token',\n});\n\nconst projects = await client.projects.list();\n\nconsole.log(projects);" }, { "lang": "Python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n team_access_token=\"My Team Access Token\",\n)\nprojects = client.projects.list()\nprint(projects)" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n teamAccessToken: 'My Team Access Token',\n);\n\n$projects = $client-\u003eprojects-\u003elist();\n\nvar_dump($projects);" }, { "lang": "Go", "source": "package main\n\nimport (\n \"context\"\n \"fmt\"\n\n \"github.com/chunkifydev/chunkify-go\"\n \"github.com/chunkifydev/chunkify-go/option\"\n)\n\nfunc main() {\n client := chunkify.NewClient(\n option.WithTeamAccessToken(\"My Team Access Token\"),\n )\n projects, err := client.Projects.List(context.TODO())\n if err != nil {\n panic(err.Error())\n }\n fmt.Printf(\"%+v\\n\", projects)\n}\n" } ] } } ``` ```json #/components/schemas/ResponseErrorAuthentication { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 401, "description": "Code is the HTTP status code", "examples": [ 401 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Authentication error: invalid token or subscription inactive" ], "type": "string" }, "type": { "const": "AuthenticationError", "description": "Type indicates the error category", "enum": [ "AuthenticationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorTooManyRequests { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 429, "description": "Code is the HTTP status code", "examples": [ 429 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Rate limit exceeded" ], "type": "string" }, "type": { "const": "TooManyRequestsError", "description": "Type indicates the error category", "enum": [ "TooManyRequestsError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ProjectListResponse { "description": "Response containing the list of projects for a team", "properties": { "data": { "description": "Data contains the project items", "items": { "$ref": "#/components/schemas/Project" }, "type": "array" }, "status": { "const": "success", "description": "Status indicates the response status \"success\"", "type": "string" } }, "required": [ "data", "status" ], "type": "object" } ``` ```json #/components/schemas/Project { "properties": { "asset_defaults": { "$ref": "#/components/schemas/AssetDefaults", "description": "Defaults for new Assets, including Assets created from Uploads." }, "created_at": { "description": "Timestamp when the project was created", "examples": [ "2025-01-01T12:00:00Z" ], "format": "date-time", "type": "string" }, "default_workflow_id": { "description": "DefaultWorkflowId specifies the default Workflow for new Assets. Set null to clear it.", "maxLength": 64, "minLength": 1, "type": [ "string", "null" ] }, "id": { "description": "Id is the unique identifier for the project.", "examples": [ "proj_2vPYfWPSk3Uejm1HHaMoDqogcVJ" ], "type": "string" }, "name": { "description": "Name of the project", "examples": [ "My Video Project" ], "type": "string" }, "slug": { "description": "Slug is the slug for the project.", "examples": [ "my-video-project" ], "type": "string" }, "storage_id": { "description": "StorageId identifier where project files are stored", "examples": [ "stor_chunkify_S1cce6120E56e7Tu9ioP09Nhjk1" ], "type": "string" } }, "required": [ "id", "name", "slug", "storage_id", "created_at", "asset_defaults" ], "type": "object" } ``` ```json #/components/schemas/AssetDefaults { "properties": { "delete_files_on_failure": { "default": false, "description": "Delete generated and partial files from the output Storage when a new Asset fails. The Asset record and original Source are preserved. Cleanup is attempted once after a delay and requires delete permission on the Storage. Defaults to false. Existing Assets are unchanged.", "type": "boolean" }, "max_resolution": { "description": "Maximum streaming resolution. Defaults to 1080p on Hobby and 2160p on other plans. 2160p requires Starter or above. Smaller sources are not upscaled. Does not affect static renditions.", "enum": [ "1080p", "2160p" ], "type": "string" }, "min_resolution": { "description": "Minimum streaming resolution. Defaults to auto, with no minimum. Must not exceed max_resolution. Smaller sources are not upscaled. Does not affect static renditions.", "enum": [ "auto", "240p", "360p", "540p", "720p", "1080p", "1440p", "2160p" ], "type": "string" }, "path_template": { "description": "PathTemplate specifies the Asset output folder relative to Storage base_prefix.\nSupports {assetID} and case-sensitive {metadata.\u003ckey\u003e}; referenced values must be non-empty.\nIgnored for Chunkify storage, which always uses {assetID}.\nDefaults to {assetID}. Maximum template size: 1024 UTF-8 bytes. Expanded prefix: 768 bytes including base_prefix and trailing slash.", "examples": [ "videos/{metadata.VideoID}" ], "minLength": 1, "type": "string", "x-maxBytes": 1024 }, "preview_enabled": { "default": true, "description": "Allow public preview access for new Assets without an API token. Defaults to true. Existing Assets are unchanged.", "type": "boolean" } }, "type": "object", "x-reject-null-fields": [ "path_template", "min_resolution", "max_resolution", "preview_enabled", "delete_files_on_failure" ] } ```