---
title: "List APIs"
method: GET
path: "/v3/apis"
tags: ["API"]
---

# List APIs

`GET /v3/apis`

Returns a collection of all APIs.

## Query parameters

- `page[size]` integer
- `page[number]` integer
- `filter` ApiFilterParameters
  - `id` UuidFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string — The field exactly matches the provided value.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `version` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `labels` LabelsFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `attributes` AttributesFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `implementation_mode` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `created_at` union — Filters on the given datetime (RFC-3339) field value.
    - object
      - `eq` string, date-time, required — Value strictly equals given RFC-3339 formatted timestamp in UTC
    - object
      - `lt` string, date-time, required — Value is less than the given RFC-3339 formatted timestamp in UTC
    - object
      - `lte` string, date-time, required — Value is less than or equal to the given RFC-3339 formatted timestamp in UTC
    - object
      - `gt` string, date-time, required — Value is greater than the given RFC-3339 formatted timestamp in UTC
    - object
      - `gte` string, date-time, required — Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC
  - `updated_at` union — Filters on the given datetime (RFC-3339) field value.
    - object
      - `eq` string, date-time, required — Value strictly equals given RFC-3339 formatted timestamp in UTC
    - object
      - `lt` string, date-time, required — Value is less than the given RFC-3339 formatted timestamp in UTC
    - object
      - `lte` string, date-time, required — Value is less than or equal to the given RFC-3339 formatted timestamp in UTC
    - object
      - `gt` string, date-time, required — Value is greater than the given RFC-3339 formatted timestamp in UTC
    - object
      - `gte` string, date-time, required — Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC
- `sort` string — The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

## Response `200`

List of APIs

- object
  - `meta` PaginatedMeta, required — returns the pagination information
    - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required
  - `data` ApiResponseSchema[], required
    - `id` string, uuid, required — The API identifier.
    - `name` string, required — The name of your API. The `name + version` combination must be unique for each API you publish.
    - `description` string, nullable — A description of your API. Will be visible on your live Portal.
    - `version` string, nullable, required — An optional version for your API. Leave this empty if your API is unversioned.
    - `current_version_summary` ApiVersionSummary, nullable, required
      - `id` string, uuid — The API version identifier.
      - `version` string — The version of this api spec.
      - `spec` object
        - `type` 'oas2' | 'oas3' | 'asyncapi' — The type of specification being stored. This allows us to render the specification correctly.
      - `created_at` string, date-time — An ISO-8601 timestamp representation of entity creation date.
      - `updated_at` string, date-time — An ISO-8601 timestamp representation of entity update date.
    - `slug` string, nullable, required — The `slug` is used in generated URLs to provide human readable paths. Defaults to `slugify(name + version)`
    - `api_spec_ids` string[], required — The list of API specification ids for the API.
    - `portals` object[], required — The list of portals which this API is published to.
      - `id` string, uuid, required — The portal identifier.
      - `name` string, required — The name of the portal, used to distinguish it from other portals.
      - `display_name` string, required — The display name of the portal. This value will be the portal's `name` in Portal API.
    - `labels` Labels, required — 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 "_".
    - `implementation_mode` string, nullable — the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement
    - `attributes` ApiAttributes — A set of attributes that describe the API
    - `created_at` string, date-time, required — An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time, required — An ISO-8601 timestamp representation of entity update date.

## Other responses

- `400` — Bad Request
- `401` — ApiUnauthorized
- `403` — ApiForbidden
- `404` — Not Found

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/revisions/68eab1ba2ab7/schema)