v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB
APIs

Get metadata pertaining to API

Get metadata pertaining to API

Get the metadata that pertains to an API. Can be global and API metadata.

get/environments/{envId}/apis/{apiId}/metadata

Query parameters

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

sourcestring[]

Determines source of API Metadata (GLOBAL or API).

sortBy'key' | '-key' | 'name' | '-name' | 'format' | '-format' | 'value' | '-value'
Example:key

Possibility to sort API Metadata results by field. Can be ascending or descending with minus '-' prefix. By default, 'key' is applied.

Response

Page of metadata

Example response

{
  "data": [
    {
      "format": "DATE"
    }
  ]
}