Retrieve Workspace Strings

This endpoint allows you to retrieve the strings associated with a specific workspace.

Request

  • Method: GET
  • URL: https://api.onesky.app/v1/workspaces/{workspace_id}/strings

Responses

The response will contain an array of strings with the following attributes:

  • string_id (string): The unique identifier for the string.
  • key (string): The key associated with the string.
  • context (string): The context in which the string is used.
  • file_id (string): The identifier of the file associated with the string.
  • total_word_count (integer): The total word count in the string.
  • created_at (string): The timestamp of when the string was created.
  • updated_at (string): The timestamp of when the string was last updated.
  • locales (object): An object containing the source and target locales for the string.
    • source (string): The source locale of the string.
    • target (array of strings): The target locales for translation.
  • content (array of strings): The content of the string.
  • tag (string): The tag associated with the string.
  • character_limit (integer): The character limit for the string.
  • translatable (boolean): Indicates whether the string is translatable.
  • archived (boolean): Indicates whether the string is archived.
  • is_plural (boolean): Indicates whether the string is plural.
  • is_translated (boolean): Indicates whether the string is translated.

Additionally, the response will include a pagination object with the following attributes:

  • total (integer): The total number of strings.
  • limit (integer): The limit of strings per page.
  • offset (integer): The offset for the current set of strings.
Language
Credentials
Bearer
Click Try It! to start a request and see the response here!