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

     1  ---
     2  summary: List projects
     3  description: List all projects the current user has access to.
     4  operationId: projects/list
     5  tags:
     6  - Projects
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/page"
    10  - "$ref": "../../parameters.yaml#/per_page"
    11  - "$ref": "../../parameters.yaml#/query_account_id"
    12  - description: Sort projects. Valid options are "name_asc", "name_desc", "updated_at_asc", "updated_at_desc", "space_asc" and "space_desc".
    13    example:
    14    name: sort_by
    15    in: query
    16    schema:
    17      type: string
    18  - description: Filter projects. Valid options are ["favorites"].
    19    example: favorites
    20    name: filters
    21    in: query
    22    schema:
    23      type: array
    24      items:
    25        type: string
    26  responses:
    27    '200':
    28      description: OK
    29      content:
    30        application/json:
    31          schema:
    32            type: array
    33            items:
    34              "$ref": "../../schemas/project.yaml#/project"
    35      headers:
    36        X-Rate-Limit-Limit:
    37          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    38        X-Rate-Limit-Remaining:
    39          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    40        X-Rate-Limit-Reset:
    41          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    42        Link:
    43          "$ref": "../../headers.yaml#/Link"
    44        Pagination:
    45          "$ref": "../../headers.yaml#/Pagination"
    46    '400':
    47      "$ref": "../../responses.yaml#/400"
    48    '404':
    49      "$ref": "../../responses.yaml#/404"
    50    '429':
    51      "$ref": "../../responses.yaml#/429"
    52  x-code-samples:
    53  - lang: Curl
    54    source: |-
    55      curl "https://api.phrase.com/v2/projects" \
    56        -u USERNAME_OR_ACCESS_TOKEN
    57  - lang: CLI v2
    58    source: |-
    59      phrase projects list \
    60      --access_token <token>
    61  x-cli-version: '2.5'