List projects within an account

post

https://api.convert.com/api/v2/accounts/{account_id}/projects

Retrieves a list of all projects belonging to the specified account that the authenticated user has access to. Supports filtering by project status, name/description search, and pagination. A project in Convert is a container for organizing experiences (A/B tests, personalizations), goals, audiences, and associated domains. As per the Knowledge Base: "Each project has its own tracking code, set of experiences, and set of collaborators."

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

Body Params

Optional filters for listing projects. You can search by name or description, filter by status (active/inactive), project_type (web/fullstack), tracking_script_release_type, specific tracking_script_version, or use pagination (page, results_per_page). Also supports only and except for specific project IDs.

onlyCount

boolean

If set to true in a list request, the response will only contain the total count of matching items (extra.pagination.items_count) and will not include the actual item data. Useful for quickly getting totals without fetching full datasets.

results_per_page

integer | null

0 to 50

Defaults to 30

Specifies the maximum number of items to return in a single page of results. Used for pagination. Default is 30, maximum is 50.

sort_direction

string | null

enum

Defaults to desc

The direction for sorting the list results, based on the sort_by field.

asc: Ascending order (e.g., A-Z, 1-10, oldest to newest).
desc: Descending order (e.g., Z-A, 10-1, newest to oldest). Defaults to desc (newest/highest first) if not specified.

Allowed:

status

array of strings | null

Filters projects by their status

status

string | null

A search string that would be used to search against Project's name and description

legacy_script

boolean | null

enum

Filters projects based on whether they use the legacy script (true) or the new script (false).

Allowed:

tracking_script_release_type

array of objects | null

Filters projects by their tracking script release type.

tracking_script_release_type

tracking_script_version

object | null

Filters projects by their tracking script version.

only

array of integers | null

Only retrieve projects with the given ids.

only

except

array of integers

length ≤ 100

Except projects with the given ids.

except

sort_by

string | null

enum

Defaults to id

A value to sort projects by specific field(s)

Defaults to id if not provided

Allowed:

project_type

array of strings | null

Filters projects by their type.

project_type

page

integer

≥ 1

The page number for paginated results. For example, if results_per_page is 30, page: 2 will retrieve items 31-60. Defaults to 1 if not specified.

include

array of objects

Specifies optional related data fields to include for each project in the list. Refer to the Optional Fields section.

include

expand

array of objects

Specifies linked objects to expand for each project in the list. Refer to the Expanding Fields section.

expand

Responses

200A list of projects accessible to the user within an account. Each project entry includes its ID, name, type (web/fullstack), status, and potentially other summary information depending on include parameters.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.