parameters.yaml

X-PhraseApp-OTP:
  in: header
  name: X-PhraseApp-OTP
  description: Two-Factor-Authentication token (optional)
  required: false
  allowEmptyValue: false
  schema:
    type: string
If-Modified-Since:
  description: 'Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)'
  explode: false
  in: header
  name: If-Modified-Since
  required: false
  schema:
    type: string
  style: simple
If-None-Match:
  description: 'ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)'
  explode: false
  in: header
  name: If-None-Match
  required: false
  schema:
    type: string
  style: simple
account_id:
  in: path
  name: account_id
  description: Account ID
  required: true
  schema:
    type: string
custom_metadata_data_type:
  in: query
  name: data_type
  description: Data Type of Custom Metadata Property
  required: false
  schema:
    "$ref": "./schemas/custom_metadata_data_type.yaml#/data_type"
  example: boolean
query_account_id:
  in: query
  name: account_id
  description: Filter by Account ID
  required: false
  schema:
    type: string
query_automation_id:
  in: query
  name: automation_id
  description: Filter events to a single automation by its ID.
  required: false
  schema:
    type: string
repo_sync_id:
  in: path
  name: repo_sync_id
  description: Repo Sync ID
  required: true
  schema:
    type: string
space_id:
  in: path
  name: space_id
  description: Space ID
  required: true
  schema:
    type: string
team_id:
  in: path
  name: team_id
  description: Team ID
  required: true
  schema:
    type: string
project_id:
  in: path
  name: project_id
  description: Project ID
  required: true
  schema:
    type: string
key_id:
  in: path
  name: key_id
  description: Translation Key ID
  required: true
  schema:
    type: string
key_id_as_id:
  in: path
  name: id
  description: Parent Translation Key ID
  required: true
  schema:
    type: string
figma_attachment_id:
  in: path
  name: figma_attachment_id
  description: Figma attachment ID
  required: true
  schema:
    type: string
job_id:
  in: path
  name: job_id
  description: Job ID
  required: true
  schema:
    type: string
job_locale_id:
  in: path
  name: job_locale_id
  description: Job Locale ID
  required: true
  schema:
    type: string
job_template_id:
  in: path
  name: job_template_id
  description: Job Template ID
  required: true
  schema:
    type: string
job_template_locale_id:
  in: path
  name: job_template_locale_id
  description: Job Template Locale ID
  required: true
  schema:
    type: string
distribution_id:
  in: path
  name: distribution_id
  description: Distribution ID
  required: true
  schema:
    type: string
screenshot_id:
  in: path
  name: screenshot_id
  description: Screenshot ID
  required: true
  schema:
    type: string
translation_id:
  in: path
  name: translation_id
  description: Translation ID
  required: true
  schema:
    type: string
glossary_id:
  in: path
  name: glossary_id
  description: Glossary ID
  required: true
  schema:
    type: string
comment_id:
  in: path
  name: comment_id
  description: Comment ID
  required: true
  schema:
    type: string
term_id:
  in: path
  name: term_id
  description: Term ID
  required: true
  schema:
    type: string
locale_codes:
  in: query
  name: locale_codes
  description: Locale Code
  required: false
  schema:
    type: string
locale_id:
  in: path
  name: locale_id
  description: Locale ID
  required: true
  schema:
    type: string
locale_id_as_id:
  in: path
  name: id
  description: Locale ID or locale name
  required: true
  schema:
    type: string
id:
  in: path
  name: id
  description: ID
  required: true
  schema:
    type: string
name:
  in: path
  name: name
  description: name
  required: true
  schema:
    type: string
tag:
  in: query
  name: tag
  description: tag
  required: false
  schema:
    type: string
branch:
  name: branch
  in: query
  description: Branch to use
  schema:
    type: string
  example: my-feature-branch
page:
  in: query
  name: page
  description: Page number
  required: false
  allowEmptyValue: false
  schema:
    type: integer
  example: 1
per_page:
  in: query
  name: per_page
  description: Limit on the number of objects to be returned, between 1 and 100. 25 by default
  required: false
  allowEmptyValue: false
  schema:
    type: integer
  example: 25
webhook_id:
  in: path
  name: webhook_id
  description: Webhook ID
  required: true
  schema:
    type: string
response_status_codes:
  in: query
  name: response_status_codes
  description: List of Response Status Codes
  required: false
  schema:
    type: string
webhook_delivery_status:
  in: query
  name: status
  description: |
    Filter deliveries by outcome. `success` returns deliveries with a 2xx response code or a soft error. `failed` returns all other deliveries, including exceptions and timeouts without a response code.
  required: false
  schema:
    type: string
    enum:
    - success
    - failed
  example: failed
q:
  description: |
    Specify a query to do broad search for keys by name (including wildcards).

    The following qualifiers are also supported in the search term:

    - `ids:key_id,...` for queries on a comma-separated list of ids
    - `name:key_name` for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes
    - `tags:tag_name` to filter for keys with certain tags
    - `translated:{true|false}` for translation status (also requires `locale_id` to be specified)
    - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries
    - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads

    **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored.

    Find more examples [here](/en/api/strings/usage-examples).
  example: mykey* translated:true
  name: q
  in: query
  schema:
    type: string
translations_q:
  in: query
  name: q
  description: |
    Specify a query to find translations by content (including wildcards).

    *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*

    The following qualifiers are supported in the query:
    * `id:translation_id,...` for queries on a comma-separated list of translation ids
    * `key.id:key_id,...` for queries on a comma-separated list of translation key ids
    * `key.name:key_name,...` for queries on a comma-separated list of translation key names
    * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids
    * `locale.name:locale_name,...` for queries on a comma-separated list of locale names
    * `tags:XYZ` for tags on the translation
    * `unverified:{true|false}` for verification status
    * `excluded:{true|false}` for exclusion status
    * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries
    * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp

    Find more examples [here](/en/api/strings/usage-examples).
  example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center
  schema:
    type: string
translations_locale_q:
  in: query
  name: q
  description: |
    Specify a query to find translations by content (including wildcards).

    *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*

    The following qualifiers are supported in the query:
    * `id:translation_id,...` for queries on a comma-separated list of translation ids
    * `key.id:key_id,...` for queries on a comma-separated list of translation key ids
    * `key.name:key_name,...` for queries on a comma-separated list of translation key names
    * `tags:XYZ` for tags on the translation
    * `unverified:{true|false}` for verification status
    * `excluded:{true|false}` for exclusion status
    * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries
    * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp

    Find more examples [here](/en/api/strings/usage-examples).
  example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center
  schema:
    type: string
translations_key_q:
  in: query
  name: q
  description: |
    Specify a query to find translations by content (including wildcards).

    *Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).*

    The following qualifiers are supported in the query:
    * `id:translation_id,...` for queries on a comma-separated list of translation ids
    * `locale.id:locale_id,...` for queries on a comma-separated list of locale ids
    * `locale.name:locale_name,...` for queries on a comma-separated list of locale names
    * `tags:XYZ` for tags on the translation
    * `unverified:{true|false}` for verification status
    * `excluded:{true|false}` for exclusion status
    * `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries
    * `reviewed_after:2013-02-21T00:00:00Z` for fetching translations that were reviewed after the given timestamp

    Find more examples [here](/en/api/strings/usage-examples).
  example: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center
  schema:
    type: string
job_owner:
  description: filter by user owning job
  example: abcd1234cdef1234abcd1234cdef1234
  name: owned_by
  in: query
  schema:
    type: string
job_assignee:
  description: filter by user assigned to job
  example: abcd1234cdef1234abcd1234cdef1234
  name: assigned_to
  in: query
  schema:
    type: string
job_state:
  description: 'filter by state of job; valid states are: `draft`, `in_progress`, `completed`'
  example: completed
  name: state
  in: query
  schema:
    type: string
job_updated_since:
  description: filter by jobs updated since given date
  example: "2013-02-21T00:00:00Z"
  name: updated_since
  in: query
  schema:
    type: string
include_annotations:
  in: query
  name: include_annotations
  description: Include job-locale annotations in the response
  required: false
  schema:
    type: boolean
    default: false
omit_translation_keys:
  in: query
  name: omit_translation_keys
  description: Omit translation keys in the response to reduce payload size for bigger jobs
  required: false
  schema:
    type: boolean
    default: false