---
title: "List API Actions"
url: "https://nov18-dev.movespot.fyi/apis/portal-api-catalog-3/versions/d7aa963d-b594-41d6-a905-3097c44bd297/operations/get-api-actions"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-api-catalog-3/versions/d7aa963d-b594-41d6-a905-3097c44bd297.md

# List API Actions

`GET` `/api/v3/apis/{apiIdOrSlug}/actions`

Operation ID: `get-api-actions`

Get a set of actions that the current developer is allowed to perform on an API.

## Path parameters

- `apiIdOrSlug` (required) - The API identifier, either ApiId or Api Slug

## Responses

- `200` - API actions
- `401` - Unauthorized
- `404` - Not Found
- `503` - Service not available

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal API Catalog
  version: 3.0.11
paths:
  /api/v3/apis/{apiIdOrSlug}/actions:
    parameters:
      - $ref: "#/components/parameters/ApiIdOrSlug"
    get:
      operationId: get-api-actions
      summary: List API Actions
      description: Get a set of actions that the current developer is allowed to
        perform on an API.
      responses:
        "200":
          $ref: "#/components/responses/ApiActions"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "503":
          $ref: "#/components/responses/NotAvailable"
      tags:
        - APIs
components:
  parameters:
    ApiIdOrSlug:
      name: apiIdOrSlug
      schema:
        oneOf:
          - $ref: "#/components/schemas/ApiId"
          - $ref: "#/components/schemas/ApiSlug"
      in: path
      required: true
      description: The API identifier, either ApiId or Api Slug
  responses:
    ApiActions:
      description: API actions
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiActionsResponse"
          examples:
            Retrieve API Actions Response:
              $ref: "#/components/examples/ApiActionsExample"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
    NotAvailable:
      description: Service not available
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BaseError"
  schemas:
    ApiId:
      description: The API identifier.
      type: string
      format: uuid
      example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
      readOnly: true
    ApiSlug:
      description: >
        The Api `slug` is used in generated URLs to provide human readable
        paths.


        Defaults to `slugify(name + version)`
      type: string
      example: my-api-v1
      pattern: ^[\w-]+$
    ApiActionsResponse:
      type: object
      properties:
        actions:
          description: List of actions that can be performed on the API
          type: object
          additionalProperties: false
          properties:
            view:
              type: boolean
            register:
              type: boolean
            view_documentation:
              type: boolean
          required:
            - view
            - register
            - view_documentation
      example:
        actions:
          view: true
          register: false
          view_documentation: true
      additionalProperties: false
      required:
        - actions
      title: API Actions Response
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    ApiActionsExample:
      value:
        actions:
          register: false
          view: true
          view_documentation: true
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
```
