Get a Resource Translations collection

Query Params
string
required

Filter results by a resource

string
required

Filter results by a language

string

The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own.

string
length ≥ 1
boolean
boolean
boolean
boolean
string
length ≥ 1
string
enum
string
string
enum

Use the value resource_string to get the list of resource string objects in the response.

Allowed:
filter[resource_string][tags][all]
array of strings
length ≥ 1

Retrieve translation strings containing all of the query tags.

filter[resource_string][tags][all]
filter[resource_string][tags][any]
array of strings
length ≥ 1

Retrieve translation strings containing any of the query tags. If the filter value is *, all strings with any tag will be returned. However, if you use * along with another tag value, such as *,tag1, only strings with either * or 'tag1' tags will be returned.

filter[resource_string][tags][any]
string
length ≥ 1

Retrieve translation strings based on specified query tags.

To filter strings, use a combination of tags with the following syntax:

  • Use an ampersand ('&') to signify 'AND' functionality, indicating that all specified tags must be present.
  • Use a pipe ('|') to signify 'OR' functionality, meaning that at least one of the specified tags must be present.
  • Use parentheses '(' to ')' to define the order of statement execution.
  • To use the above special characters as part of the query content, escape them with a backslash ('\')

When combining AND and OR conditions, the query is evaluated from left to right, following operator precedence and respecting existing parentheses. Specifically, the AND operator (&) takes precedence over the OR operator (|).

For example, consider the query: 'tag1&(tag2|tag3)'

This query is interpreted as follows: tag1 AND (tag2 OR tag3), and it returns strings that have both "tag1" and either "tag2" or "tag3"

Similarly, for the query: 'tag1&tag2|tag3'

This query is read as follows: (tag1 AND tag2) OR tag3, and it returns strings that have both "tag1" and "tag2" or have "tag3"

string | null

The page size limit. If not set, the default value is 150.
If set, the minimum value it can take is 150 and the maximum 1000.

Responses

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json