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

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

# List API Attributes

`GET` `/api/v3/api-attributes`

Operation ID: `get-paginated-api-attributes`

Get a paginated list of all attributes across APIs in the portal. If authenticated, results will include attributes of APIs visible to the authenticated user. If not authenticated, results will include only attributes of publicly visible APIs. When the `selected` query parameter is provided, the response will include a `selected_api_count` field for each attribute value, indicating how many APIs would match that attribute value when combined with the currently selected filters.

## Query parameters

- `filter` (object, optional) - Filters API attributes in the response.
- `selected` (object, optional) - Specifies selected attribute values to calculate filtered API counts. Use the format: selected[<attribute_key>]=<attribute_value_1>,<attribute_value_2> When provided, the response will include selected_api_count for each attribute value.

## Responses

- `200` - Paginated list of attributes across all APIs published in this portal.
- `400` - Bad Request
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal API Catalog
  version: 3.0.11
paths:
  /api/v3/api-attributes:
    get:
      operationId: get-paginated-api-attributes
      summary: List API Attributes
      description: >
        Get a paginated list of all attributes across APIs in the portal.

        If authenticated, results will include attributes of APIs visible to the
        authenticated user.

        If not authenticated, results will include only attributes of publicly
        visible APIs.


        When the `selected` query parameter is provided, the response will
        include a `selected_api_count`

        field for each attribute value, indicating how many APIs would match
        that attribute value

        when combined with the currently selected filters.
      parameters:
        - $ref: "#/components/parameters/ApiAttributeFilters"
        - $ref: "#/components/parameters/SelectedApiAttributes"
      responses:
        "200":
          $ref: "#/components/responses/ListApiAttributes"
        "400":
          $ref: "#/components/responses/BadRequest"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - API Attributes
components:
  parameters:
    ApiAttributeFilters:
      name: filter
      description: Filters API attributes in the response.
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/ApiAttributeFilterParameters"
      style: deepObject
    SelectedApiAttributes:
      name: selected
      description: >
        Specifies selected attribute values to calculate filtered API counts.

        Use the format:
        selected[<attribute_key>]=<attribute_value_1>,<attribute_value_2>

        When provided, the response will include selected_api_count for each
        attribute value.
      required: false
      in: query
      schema:
        type: object
        example:
          domain: airlines,flights
          visibility: external
        additionalProperties:
          type: string
          description: Comma-separated list of selected values for this attribute key
      style: deepObject
  responses:
    ListApiAttributes:
      description: Paginated list of attributes across all APIs published in this portal.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ListApiAttributesPage"
          examples:
            ListApiAttributesPageExample:
              $ref: "#/components/examples/ListApiAttributesPageExample"
            ListApiAttributesWithSelectedExample:
              $ref: "#/components/examples/ListApiAttributesWithSelectedExample"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    ApiAttributeFilterParameters:
      type: object
      properties:
        key:
          $ref: "#/components/schemas/StringFieldFilter"
      title: API Attribute Filter Parameters
    ListApiAttributesPage:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/ApiAttributeItem"
      additionalProperties: false
      required:
        - meta
        - data
      title: ListApiAttributesPage
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    StringFieldFilter:
      oneOf:
        - title: Filter by operator
          description: "Filter using **one** of the following operators: `eq`, `oeq`,
            `neq`, `contains`, `ocontains`"
          x-examples:
            example-1:
              contains: some-value
              ocontains: this-value,or-that-value
              oeq: some-value,some-other-value
              neq: not-this-value
            example-2:
              eq: some-value
          properties:
            eq:
              description: The field exactly matches the provided value.
              type: string
              example: ?filter[field_name_here][eq]=foo
            contains:
              description: The field contains the provided value.
              type: string
              example: ?filter[field_name_here][contains]=foo
            ocontains:
              description: The field contains any of the provided values.
              type: string
              example: ?filter[field_name_here][ocontains]=foo,bar
            oeq:
              description: The field matches any of the provided values.
              type: string
              example: ?filter[field_name_here][oeq]=foo,bar
            neq:
              description: The field does not match the provided value.
              type: string
              example: ?filter[field_name_here][neq]=bar
          type: object
          additionalProperties: false
        - title: Filter by exact string match
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[title]=foo
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    ApiAttributeItem:
      type: object
      properties:
        key:
          type: string
        values:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - value
              - api_count
            properties:
              value:
                type: string
              api_count:
                type: number
              selected_api_count:
                description: >
                  The number of APIs that match this attribute value when
                  considering the selected filters.

                  Only present when the 'selected' query parameter is provided.
                type: number
      additionalProperties: false
      required:
        - key
        - values
      title: ApiAttributeItem
    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
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    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
    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:
    ListApiAttributesPageExample:
      value:
        data:
          - key: env
            values:
              - value: production
                api_count: 5
              - value: staging
                api_count: 5
          - key: domain
            values:
              - value: identity
                api_count: 2
              - value: booking
                api_count: 2
              - value: planning
                api_count: 4
              - value: add-ons
                api_count: 2
        meta:
          page:
            number: 1
            size: 2
            total: 2
    ListApiAttributesWithSelectedExample:
      summary: Example with selected filters applied
      description: >
        Example response when selected[domain]=identity,booking is provided as a
        query parameter.

        The selected_api_count shows the count when only APIs with domain
        'identity' or 'booking' are considered.
      value:
        data:
          - key: env
            values:
              - value: production
                api_count: 5
                selected_api_count: 2
              - value: staging
                api_count: 5
                selected_api_count: 2
          - key: domain
            values:
              - value: identity
                api_count: 2
                selected_api_count: 2
              - value: booking
                api_count: 2
                selected_api_count: 2
              - value: planning
                api_count: 4
                selected_api_count: 0
              - value: add-ons
                api_count: 2
                selected_api_count: 0
        meta:
          page:
            number: 1
            size: 2
            total: 2
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
```
