Skip to content

List List Folders

GET
/lists/folders

Folders the key’s org owns, plus org-visible folders owned by teammates.

assignments maps list id -> folder id, which is what a rebuilt Lists screen needs to place each list without a second round trip.

The internal list_folders takes TWO different scope classes: a campaign_builder service_scope (carrying .is_scoped/.allowed_list_ids) and an audiences visibility_scope. They are resolved by distinct dependencies - passing one object as both raises AttributeError -> 500.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Folders the caller owns, plus org-visible folders owned by teammates.

folders keeps its existing meaning - “mine”. shared_folders is browse-only, mirroring the app so a rebuilt UI can render the same split.

object
assignments

Map of list id -> folder id for every filed list.

object
key
additional properties
string format: uuid
folders
Array<object>

A folder a developer can group lists into.

object
created_at
Any of:
string format: date-time
created_by
required

User id that created the folder.

string
id
required

Folder id.

string format: uuid
is_owner
required

True when the calling key’s org owns the folder.

boolean
list_count
required

Number of lists currently filed in this folder.

integer
title
required

Display title.

string
updated_at
Any of:
string format: date-time
visibility
required

private (owner only) or org (browse-only for teammates).

string
shared_folders
Array<object>

A folder a developer can group lists into.

object
created_at
Any of:
string format: date-time
created_by
required

User id that created the folder.

string
id
required

Folder id.

string format: uuid
is_owner
required

True when the calling key’s org owns the folder.

boolean
list_count
required

Number of lists currently filed in this folder.

integer
title
required

Display title.

string
updated_at
Any of:
string format: date-time
visibility
required

private (owner only) or org (browse-only for teammates).

string
starred_ids

List ids the caller has starred.

Array<integer>
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string