Skip to main content
GET
/
projects
List
curl --request GET \
  --url https://api.beyondwords.io/v1/projects \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "name": "My project",
    "language": "en_US",
    "auto_publish_enabled": true,
    "avatar_url": "https://example.com/avatar.jpg",
    "environment": "production",
    "created": "2022-01-02 23:59:59 UTC",
    "updated": "2022-03-04 00:00:00 UTC"
  },
  {
    "id": 2,
    "name": "My second project",
    "language": "en_GB",
    "auto_publish_enabled": true,
    "avatar_url": "https://example.com/avatar.jpg",
    "environment": "production",
    "created": "2022-01-02 23:59:59 UTC",
    "updated": "2022-03-04 00:00:00 UTC"
  }
]

Authorizations

​
X-Api-Key
string
header
required

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]
enum<string>

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

Available options:
name,
created
​
order[dir]
enum<string>

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

Available options:
asc,
desc
​
filter[environment]
enum<string>

filter by environment

Available options:
production,
staging
​
filter[name]
string

filter by name

​
filter[language.code]
string

filter by language code

Response

OK

​
id
integer

Unique identifier for the object

​
name
string

The project name

​
language
string

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

​
language_data
object

Additional language metadata for the project

​
environment
enum<string> | null
Available options:
production,
staging
​
content_total_count
integer
​
content_updated
string<date-time> | null
​
title
object
​
summary
object | null
​
body
object
​
background_track
object | null
​
auto_publish_enabled
boolean

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

​
auto_video_published_enabled
boolean

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

​
time_zone
string

The project time zone (IANA time zone name)

​
avatar_url
string<uri> | null

The project's avatar URL

Maximum length: 2048
​
created
string<date-time>

Time at which the object was created (ISO 8601)

​
updated
string<date-time>

Time at which the object was updated (ISO 8601)