BEbeyondwords
Projects

List projects

Changed on

Lists all projects in your organization.

get/projects

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects
  • Auth
    API key in header X-Api-Key

Query parameters

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' | 'archived'

filter by environment

filter[name]string

filter by name

filter[language.code]string

filter by language code

Response

OK

idinteger

Unique identifier for the object

namestring

The project name

descriptionstring nullable

A short description of the publication, used by the AI agent and AI assistant surfaces.

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' | 'archived' 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)

generate_audioboolean

When false, new content is prepared and indexed without audio generation unless content generate_audio is provided. Changing it affects future content only (default is true)

integration_import_content_fromstring date-time nullable

New content published before this time (inclusive cutoff) isn't imported by RSS feeds, Ghost and Magic Embed. Other content creation isn't affected. Changing it doesn't affect existing content (default is null, no restriction)

integration_generate_audio_fromstring date-time nullable

Audio is generated only for new RSS feed, Ghost and Magic Embed content published at or after this time, earlier content is prepared and indexed without audio. Other content creation isn't affected. Changing it doesn't affect existing content (default is null, no restriction)

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)

Changes

  • 994b9853e685Revision changes
    • warning

      added the new archived enum value to the / response property for the response status

    • info

      added the new enum value archived to the query request parameter filter[environment]

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status