---
title: "Get an API"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6/operations/fetch-api"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6.md

# Get an API

`GET` `/apis/{apiId}`

Operation ID: `fetch-api`

Get an API.

## Path parameters

- `apiId` (string, uuid, required) - The UUID API identifier

## Responses

- `200` - API
- `401` - ApiUnauthorized
- `403` - ApiForbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /apis/{apiId}:
    parameters:
      - name: apiId
        in: path
        description: The UUID API identifier
        required: true
        schema:
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
    get:
      operationId: fetch-api
      summary: Get an API
      description: Get an API.
      responses:
        "200":
          $ref: "#/components/responses/ApiResponse"
        "401":
          $ref: "#/components/responses/ApiUnauthorized"
        "403":
          $ref: "#/components/responses/ApiForbidden"
        "404":
          $ref: "#/components/responses/ApiNotFound"
      tags:
        - API
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  responses:
    ApiResponse:
      description: API
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiResponseSchema"
          examples:
            CreateApiResponse:
              $ref: "#/components/examples/ApiExample"
    ApiUnauthorized:
      description: ApiUnauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            ApiUnauthorizedExample:
              $ref: "#/components/examples/ApiUnauthorizedExample"
    ApiForbidden:
      description: ApiForbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            ApiForbiddenExample:
              $ref: "#/components/examples/ApiForbiddenExample"
    ApiNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            ApiNotFoundExample:
              $ref: "#/components/examples/ApiNotFoundExample"
  schemas:
    ApiResponseSchema:
      type: object
      properties:
        id:
          description: The API identifier.
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
          readOnly: true
        name:
          description: >
            The name of your API. The `name + version` combination must be
            unique for each API you publish.
          type: string
          example: MyAPI
          maxLength: 255
          minLength: 1
        description:
          description: A description of your API. Will be visible on your live Portal.
          type: string
          nullable: true
        version:
          description: An optional version for your API. Leave this empty if your API is
            unversioned.
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        current_version_summary:
          $ref: "#/components/schemas/ApiVersionSummary"
        slug:
          description: >
            The `slug` is used in generated URLs to provide human readable
            paths.


            Defaults to `slugify(name + version)`
          type: string
          example: my-api-v1
          nullable: true
          pattern: ^[\w-]+$
        api_spec_ids:
          description: The list of API specification ids for the API.
          type: array
          items:
            type: string
            format: uuid
            description: The id of the API specification.
            example: 123e4567-e89b-12d3-a456-426614174000
          deprecated: true
          readOnly: true
        portals:
          description: The list of portals which this API is published to.
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - id
              - name
              - display_name
            properties:
              id:
                description: The portal identifier.
                type: string
                format: uuid
                example: 25a2624c-49fc-4764-99e1-224ed819f200
              name:
                description: The name of the portal, used to distinguish it from other portals.
                type: string
                example: My Portal
              display_name:
                description: The display name of the portal. This value will be the portal's
                  `name` in Portal API.
                type: string
                example: My Portal
          nullable: false
          readOnly: true
          uniqueItems: true
        labels:
          $ref: "#/components/schemas/Labels"
        implementation_mode:
          description: the implementations that are associated with this api either
            gateway_entity_binding or access_control_enforcement
          type: string
          nullable: true
          readOnly: true
        attributes:
          $ref: "#/components/schemas/ApiAttributes"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - name
        - version
        - labels
        - created_at
        - updated_at
        - slug
        - portals
        - api_spec_ids
        - current_version_summary
      title: API
    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
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    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
    ApiVersionSummary:
      type: object
      properties:
        id:
          description: The API version identifier.
          type: string
          format: uuid
          example: 7710d5c4-d902-410b-992f-18b814155b53
          readOnly: true
        version:
          description: The version of this api spec.
          type: string
        spec:
          type: object
          additionalProperties: false
          properties:
            type:
              $ref: "#/components/schemas/ApiSpecType"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      nullable: true
      readOnly: true
      title: API Version Summary
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    ApiAttributes:
      description: A set of attributes that describe the API
      type: object
      example:
        env:
          - production
        domains:
          - web
          - mobile
      default: {}
      additionalProperties:
        nullable: true
        description: Set of attributes with unique keys. Each key can include lowercase
          letters, numbers, hyphens, and underscores.
        type: array
        minItems: 1
        maxItems: 20
        items:
          type: string
          minLength: 1
          maxLength: 512
          pattern: ^[^,<>]*$
      nullable: false
      title: API Attributes
    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
    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
    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
  examples:
    ApiExample:
      value:
        id: 9f5061ce-78f6-4452-9108-ad7c02821fd5
        name: myAPI
        version: v1
        labels:
          env: test
        description: My API
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
        slug: my-api-v1
        current_version_summary:
          id: 7710d5c4-d902-410b-992f-18b814155b53
          version: v1
          spec:
            type: oas3
          created_at: 2023-01-01T00:00:00.000Z
          updated_at: 2023-01-01T00:00:00.000Z
        portals:
          - id: 25a2624c-49fc-4764-99e1-224ed819f200
            name: My-Portal
            display_name: My Portal
        api_spec_ids:
          - 123e4567-e89b-12d3-a456-426614174000
    ApiUnauthorizedExample:
      value:
        status: 401
        title: ApiUnauthorized
        instance: kong:trace:8347343766220159418
        detail: ApiUnauthorized
    ApiForbiddenExample:
      value:
        status: 403
        title: ApiForbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    ApiNotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
