---
title: "Get API"
url: "https://nov18-dev.movespot.fyi/apis/portal-api-catalog-dev-3/versions/861ffb03-94d9-4545-a275-2893d1e5641b/operations/fetch-api"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-api-catalog-dev-3/versions/861ffb03-94d9-4545-a275-2893d1e5641b.md

# Get API

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

Operation ID: `fetch-api`

Gets the details for an existing published API.

## Path parameters

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

## Responses

- `200` - Response for a single api's details.
- `400` - Bad Request
- `401` - Unauthorized
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal API Catalog
  version: 3.0.11
paths:
  /api/v3/apis/{apiIdOrSlug}:
    get:
      operationId: fetch-api
      summary: Get API
      description: Gets the details for an existing published API.
      parameters:
        - $ref: "#/components/parameters/ApiIdOrSlug"
      responses:
        "200":
          $ref: "#/components/responses/ApiGet"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      security:
        - portalAccessToken: []
        - {}
      tags:
        - APIs
security:
  - portalAccessToken: []
  - {}
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:
    ApiGet:
      description: Response for a single api's details.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Api"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    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"
  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-]+$
    Api:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        name:
          description: Name of API.
          type: string
          example: Billing
        version:
          description: Version of API.
          type: string
          example: v1
          nullable: true
        description:
          type: string
          example: V1 API for billing functions
          nullable: true
        visibility:
          description: >
            Visibility of the API listing.

            Public APIs are visible to anyone and do not require authentication
            to view and retrieve information about them.

            Private APIs are only visible to authenticated developers who have
            been granted access.
          type: string
          enum:
            - public
            - private
        slug:
          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
          nullable: false
          pattern: ^[\w-]+$
        auth_strategies:
          description: Configurations for how the API is able to be registered for by
            applications.
          type: array
          items:
            $ref: "#/components/schemas/AuthStrategy"
        specifications:
          description: >
            Returns a list of specifications for an API.

            **Note:** This Beta property is deprecated and will be removed in a
            GA release.
          type: array
          items:
            type: object
            required:
              - id
              - type
            properties:
              id:
                description: The API specification identifier.
                type: string
                format: uuid
                example: 7710d5c4-d902-410b-992f-18b814155b53
                readOnly: true
              type:
                $ref: "#/components/schemas/ApiSpecType"
          deprecated: true
        current_version_summary:
          description: >
            Summary of the current version (version string of api.version
            matches version)
          type: object
          additionalProperties: false
          nullable: true
          properties:
            id:
              description: The API version identifier.
              type: string
              format: uuid
              example: 7710d5c4-d902-410b-992f-18b814155b53
              readOnly: true
            spec:
              type: object
              additionalProperties: false
              properties:
                type:
                  $ref: "#/components/schemas/ApiSpecType"
              required:
                - type
          required:
            - id
            - spec
        attributes:
          description: A set of attributes that describe the API
          type: object
          example:
            availability:
              - general
            domain:
              - financial
              - billing
          additionalProperties:
            description: Set of unique attribute names
            type: array
            items:
              description: A value associated with the attribute
              type: string
        images:
          type: object
          example:
            icon:
              uri: /apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw
          additionalProperties: false
          nullable: true
          properties:
            icon:
              type: object
              additionalProperties: false
              nullable: true
              properties:
                uri:
                  description: The relative API path for retrieving the raw the icon image.
                  type: string
                  format: uri-reference
                  nullable: true
                  pattern: ^/[^\s]+/images/icon/raw$
          readOnly: true
          title: Images
      additionalProperties: false
      required:
        - id
        - created_at
        - updated_at
        - name
        - version
        - description
        - visibility
        - slug
        - specifications
        - attributes
      title: Api
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    AuthStrategy:
      type: object
      discriminator:
        propertyName: credential_type
      oneOf:
        - $ref: "#/components/schemas/AuthStrategyKeyAuth"
        - $ref: "#/components/schemas/AuthStrategyClientCredentials"
    ApiSpecType:
      description: >
        The type of specification being stored. This allows us to render the
        specification correctly.
      type: string
      example: oas3
      enum:
        - oas2
        - oas3
        - asyncapi
      title: API Spec Type
    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
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    AuthStrategyKeyAuth:
      description: KeyAuth Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - key_auth
        key_names:
          type: array
          items:
            type: string
        ttl:
          description: Default maximum Time-To-Live for keys created under this strategy.
          type: object
          properties:
            value:
              type: integer
              minimum: 1
            unit:
              type: string
              enum:
                - days
                - weeks
                - years
          required:
            - value
            - unit
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - key_names
    AuthStrategyClientCredentials:
      description: Client Credential Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - client_credentials
            - self_managed_client_credentials
        auth_methods:
          $ref: "#/components/schemas/AuthMethods"
        available_scopes:
          $ref: "#/components/schemas/AvailableScopes"
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - auth_methods
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    AuthMethods:
      type: array
      items:
        description: Auth Methods enabled for this strategy
        type: string
      example:
        - bearer
    AvailableScopes:
      description: Possible developer selectable scopes for an application. Only
        present when using DCR Provider that supports it.
      type: array
      items:
        type: string
      example:
        - scope1
        - scope2
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    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
  securitySchemes:
    portalAccessToken:
      type: apiKey
      in: cookie
      name: portalaccesstoken
      description: >
        The Developer portal cookie is meant to be used by the Developer API to
        authenticate with.
```
