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

     1  ---
     2  summary: List invitations
     3  description: List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.
     4  operationId: invitations/list
     5  tags:
     6  - Invitations
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/account_id"
    10  - "$ref": "../../parameters.yaml#/page"
    11  - "$ref": "../../parameters.yaml#/per_page"
    12  responses:
    13    '200':
    14      description: OK
    15      content:
    16        application/json:
    17          schema:
    18            type: array
    19            items:
    20              "$ref": "../../schemas/invitation.yaml#/invitation"
    21      headers:
    22        X-Rate-Limit-Limit:
    23          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    24        X-Rate-Limit-Remaining:
    25          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    26        X-Rate-Limit-Reset:
    27          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    28        Link:
    29          "$ref": "../../headers.yaml#/Link"
    30        Pagination:
    31          "$ref": "../../headers.yaml#/Pagination"
    32    '400':
    33      "$ref": "../../responses.yaml#/400"
    34    '401':
    35      "$ref": "../../responses.yaml#/401"
    36    '403':
    37      "$ref": "../../responses.yaml#/403"
    38    '404':
    39      "$ref": "../../responses.yaml#/404"
    40    '429':
    41      "$ref": "../../responses.yaml#/429"
    42  x-code-samples:
    43  - lang: Curl
    44    source: |-
    45      curl "https://api.phrase.com/v2/accounts/:account_id/invitations" \
    46        -u USERNAME_OR_ACCESS_TOKEN
    47  - lang: CLI v2
    48    source: |-
    49      phrase invitations list \
    50      --account_id <account_id> \
    51      --access_token <token>
    52  x-cli-version: '2.5'