> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asobeast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read a stored iOS keyword field

> Returns the keyword field of one App Store localization: phrases is the field as saved, in order, and tracked is those of its phrases tracked and active in country. Without a query it reads the home storefront's default localization. duplicatesRemoved is always 0 because a read discards nothing.



## OpenAPI

````yaml /api-reference/openapi.json get /apps/{id}/keyword-field
openapi: 3.0.0
info:
  title: asobeast API
  description: >-
    Self hosted ASO toolkit API.


    A metered instance carries RateLimit-Limit, RateLimit-Remaining and
    RateLimit-Reset on every response, for the tightest limit the request
    touched. A self hosted instance has no request rate limits and sends no such
    header. Limits are per workspace, so minting more tokens does not buy more
    capacity, and they are sized per plan across three classes: read for stored
    data, write for configuration changes and store for the endpoints that reach
    the App Store or Google Play.


    A 429 carries Retry-After and a rateLimit object naming the window that
    closed, or an aiAllowance object when the workspace has spent the AI calls
    its plan includes this month. A 403 with a quota object means a plan
    capacity limit such as apps or tracked keyword markets, which is a different
    problem from a rate limit. A 402 with an entitlement object means the
    workspace needs a plan.


    Positions are 1-based and null means checked but not found within the
    captured depth, never zero. Daily granularity uses UTC dates.
  version: 1.9.0
  contact: {}
servers:
  - url: http://localhost:3000/api/backend
    description: Web origin proxy
  - url: http://localhost:4000
    description: Direct API
security:
  - personalApiToken: []
tags: []
paths:
  /apps/{id}/keyword-field:
    get:
      tags:
        - keywords
      summary: Read a stored iOS keyword field
      description: >-
        Returns the keyword field of one App Store localization: phrases is the
        field as saved, in order, and tracked is those of its phrases tracked
        and active in country. Without a query it reads the home storefront's
        default localization. duplicatesRemoved is always 0 because a read
        discards nothing.
      operationId: KeywordsController_keywordField
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: country
          required: false
          in: query
          description: >-
            The storefront the field is read in and its phrases are tracked in.
            Omitted means the home storefront.
          schema:
            type: string
            example: us
            pattern: ^[a-z]{2}$
        - name: localization
          required: false
          in: query
          description: >-
            The App Store localization whose keyword field this is. It must be
            one the storefront reads. Omitted means the storefront's default
            localization.
          schema:
            enum:
              - ar
              - bn
              - ca
              - zh-Hans
              - zh-Hant
              - hr
              - cs
              - da
              - nl
              - en-AU
              - en-CA
              - en-GB
              - en-US
              - fi
              - fr
              - fr-CA
              - de
              - el
              - gu
              - he
              - hi
              - hu
              - id
              - it
              - ja
              - kn
              - ko
              - ms
              - ml
              - mr
              - 'no'
              - or
              - pl
              - pt-BR
              - pt-PT
              - pa
              - ro
              - ru
              - sk
              - sl
              - es-MX
              - es-ES
              - sv
              - ta
              - te
              - th
              - tr
              - uk
              - ur
              - vi
            type: string
            example: es-MX
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    personalApiToken:
      scheme: bearer
      bearerFormat: asob
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.