v1

latestOpenAPI 3.0.12026-07-2210997354.2 KB

Projects

List projects

Lists all projects in your organization.

get/projects

pagination[limit]integer

'limit' sets the number of results to return in each page.

pagination[offset]integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

order[by]'name' | 'created'

This is used to order projects by type or key or value

order[dir]'asc' | 'desc'

This is used to order analytics in the ascending or descending order

filter[environment]'production' | 'staging'

filter by environment

filter[name]string

filter by name

filter[language.code]string

filter by language code

idinteger

Unique identifier for the object

namestring

The project name

languagestring

The default language of the project (ISO 639-1 code with optional region, e.g., en_GB)

language_dataobject

Additional language metadata for the project

environment'production' | 'staging' nullable

logo_colorstring nullable

content_total_countinteger

content_updatedstring date-time nullable

auto_publish_enabledboolean

When true, automatically distribute content once generated (default is true)

auto_video_publish_enabledboolean

When true, automatically distribute video content once generated (default is true)

time_zonestring

The project time zone (IANA time zone name)

avatar_urlstring uri nullable

The project's avatar URL

pause_after_title_segments_secondsnumber

pause_after_segments_secondsnumber

createdstring date-time

Time at which the object was created (ISO 8601)

updatedstring date-time

Time at which the object was updated (ISO 8601)