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

     1  ---
     2  summary: Get a single invitation
     3  description: Get details on a single invitation. Access token scope must include <code>team.manage</code>.
     4  operationId: invitation/show
     5  tags:
     6  - Invitations
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/account_id"
    10  - "$ref": "../../parameters.yaml#/id"
    11  responses:
    12    '200':
    13      description: OK
    14      content:
    15        application/json:
    16          schema:
    17            "$ref": "../../schemas/invitation.yaml#/invitation"
    18      headers:
    19        X-Rate-Limit-Limit:
    20          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    21        X-Rate-Limit-Remaining:
    22          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    23        X-Rate-Limit-Reset:
    24          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    25    '400':
    26      "$ref": "../../responses.yaml#/400"
    27    '401':
    28      "$ref": "../../responses.yaml#/401"
    29    '403':
    30      "$ref": "../../responses.yaml#/403"
    31    '404':
    32      "$ref": "../../responses.yaml#/404"
    33    '429':
    34      "$ref": "../../responses.yaml#/429"
    35  x-code-samples:
    36  - lang: Curl
    37    source: |-
    38      curl "https://api.phrase.com/v2/accounts/:account_id/invitations/:id" \
    39        -u USERNAME_OR_ACCESS_TOKEN
    40  - lang: CLI v2
    41    source: |-
    42      phrase invitations show \
    43      --account_id <account_id> \
    44      --id <id> \
    45      --access_token <token>
    46  x-cli-version: '2.5'