github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/custom_metadata_properties/index.yaml (about)

     1  ---
     2  summary: List properties
     3  description: |
     4    List all custom metadata properties for an account.
     5  
     6    This endpoint is only available to accounts with advanced plans or above.
     7  operationId: custom_metadata_properties/list
     8  tags:
     9  - Custom Metadata
    10  parameters:
    11  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
    12  - "$ref": "../../parameters.yaml#/account_id"
    13  - "$ref": "../../parameters.yaml#/custom_metadata_data_type"
    14  - description: id of project that the properties belong to
    15    example: abcd1234cdef1234abcd1234cdef1234
    16    name: project_id
    17    in: query
    18    schema:
    19      type: string
    20  - "$ref": "../../parameters.yaml#/page"
    21  - "$ref": "../../parameters.yaml#/per_page"
    22  - description: query to find a property by name
    23    example: character_name
    24    name: q
    25    in: query
    26    schema:
    27      type: string
    28  - description: 'Sort criteria. Can be one of: name, data_type, created_at.'
    29    example: updated_at
    30    name: sort
    31    in: query
    32    schema:
    33      type: string
    34  - description: 'Order direction. Can be one of: asc, desc.'
    35    example: desc
    36    name: order
    37    in: query
    38    schema:
    39      type: string
    40  responses:
    41    '200':
    42      description: OK
    43      content:
    44        application/json:
    45          schema:
    46            type: array
    47            items:
    48              "$ref": "../../schemas/custom_metadata_property.yaml#/custom_metadata_property"
    49      headers:
    50        X-Rate-Limit-Limit:
    51          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    52        X-Rate-Limit-Remaining:
    53          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    54        X-Rate-Limit-Reset:
    55          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    56        Link:
    57          "$ref": "../../headers.yaml#/Link"
    58        Pagination:
    59          "$ref": "../../headers.yaml#/Pagination"
    60    '400':
    61      "$ref": "../../responses.yaml#/400"
    62    '404':
    63      "$ref": "../../responses.yaml#/404"
    64    '429':
    65      "$ref": "../../responses.yaml#/429"
    66  x-code-samples:
    67  - lang: Curl
    68    source: |-
    69      curl "https://api.phrase.com/v2/accounts/:account_id/custom_metadata/properties?data_type=boolean&project_id=1&page=1&per_page=10&sort=created_at&order=desc" \
    70        -u USERNAME_OR_ACCESS_TOKEN
    71  - lang: CLI v2
    72    source: |-
    73      phrase custom_metadata_properties list \
    74      --account_id <account_id> \
    75      --data_type boolean \
    76      --project_id 1 \
    77      --page 1 \
    78      --per_page 10 \
    79      --sort created_at \
    80      --order desc \
    81      --access_token <token>
    82  x-cli-version: '2.9'