Skip to navigation

API · Projects · List projects of a type (Project or AdCreativeProject)

View as Markdown

List projects of the given resourcetype in the workspace, paginated and newest-first. Returns project objects with their UUIDs — needed for getProject, listProjectItems, and deleteProject. Filter with ?search=<title>. Pass the same resourcetype you created the projects with.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

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

Path parameters

resourcetypeenumRequired

Project type selector (the model name). The API is polymorphic — the same URL structure serves different project types based on this value. Valid values:

  • Project — generic projects (the default for most content).
  • AdCreativeProject — ad-creative projects (specialized fields). Use the same value on create, get, list, and delete for a given project.
Allowed values:

Query parameters

primary_typestringOptional<=24 characters

Filter by a SINGLE primary type — not a comma-separated list; the server rejects anything over 24 characters. Values are free-form and case-sensitive, e.g. ad, image, quote, thumbnail, AIAvatarVideo, UGCVideo, SMQuotes, ImageYTThumb. Call without this parameter to list every type, then filter client-side.

orderingstringOptional
Field to order results by
searchstringOptional
Search term to filter projects
thread_idstringOptional

Return only the projects recorded while working in one conversation. Pass current for the conversation you are in — the toolkit replaces it with the real thread id, so an id you compose yourself is ignored.

expandstringOptional

Comma-separated fields to expand inline. Pass items to get each project's deliverables in the same response instead of calling listProjectItems per project.

Response

List of projects

Errors

401
Unauthorized Error