Skip to main content
GET
List Projects

Overview

Retrieve a list of all projects associated with your Pictory account. Projects represent video creation workflows at various stages, including those created from scripts, video/audio transcriptions, or URLs.
You need a valid API key to use this endpoint. Get your API key from the API Access page in your Pictory dashboard.

API Endpoint


Request Parameters

Headers

Authorization
string
required
API key for authentication (starts with pictai_)

Query Parameters

pagekey
string
Pagination token for retrieving the next page of results. Pass this value exactly as received from the pageKey field in the previous API response.
folder
string
Filter to retrieve projects from a specific folder by folder ID

Response

items
array of objects
Array of project objects
pageKey
string | null
Pagination token for retrieving the next page of results. null if there are no more pages.

Response Examples


Code Examples

Replace YOUR_API_KEY with your actual API key that starts with pictai_

Usage Notes

Projects are returned in reverse chronological order by saved date, with the most recently saved projects appearing first.
Pagination: When you have many projects, use the pageKey value from the response to retrieve subsequent pages. Pass the pageKey as the pagekey query parameter in your next request.
Schema Versions: Projects may have different schema versions (v2, v3, or null). The schema version affects the structure and capabilities of the project. Newer schema versions (v3) typically support more features.

Common Use Cases

1. List All Projects

Retrieve and display all projects in your account:

2. Paginate Through Projects

Handle pagination to retrieve all projects across multiple pages:

3. Filter Projects by Source Type

Filter projects based on how they were created:

4. Get Projects from Specific Folder

Retrieve projects from a specific folder:

5. Find Recently Modified Projects

Get projects modified within the last N days:

6. Organize Projects by Schema Version

Group projects by their schema version:

7. Export Project Metadata

Export project metadata to CSV or JSON:

8. Search Projects by Name

Search for projects by name pattern: