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

     1  ---
     2  summary: List notifications
     3  description: List all notifications from the current user
     4  operationId: notifications/list
     5  tags:
     6  - Notifications
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/page"
    10  - "$ref": "../../parameters.yaml#/per_page"
    11  - description: Include only unseen notifications
    12    example: true
    13    name: unseen
    14    in: query
    15    schema:
    16      type: boolean
    17  responses:
    18    '200':
    19      description: OK
    20      content:
    21        application/json:
    22          schema:
    23            type: array
    24            items:
    25              "$ref": "../../schemas/notification.yaml#/notification"
    26      headers:
    27        X-Rate-Limit-Limit:
    28          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    29        X-Rate-Limit-Remaining:
    30          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    31        X-Rate-Limit-Reset:
    32          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    33        Link:
    34          "$ref": "../../headers.yaml#/Link"
    35        Pagination:
    36          "$ref": "../../headers.yaml#/Pagination"
    37    '400':
    38      "$ref": "../../responses.yaml#/400"
    39    '404':
    40      "$ref": "../../responses.yaml#/404"
    41    '429':
    42      "$ref": "../../responses.yaml#/429"
    43  x-code-samples:
    44  - lang: Curl
    45    source: |-
    46      curl "https://api.phrase.com/v2/notifications" \
    47        -u USERNAME_OR_ACCESS_TOKEN
    48  - lang: CLI v2
    49    source: |-
    50      phrase notifications list \
    51      --access_token <token>
    52  x-cli-version: '2.5'