Skip to main content
GET
Get List of APIs

Authorizations

Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Query Parameters

compressed
enum<string>

Return smaller API list payload.

Available options:
1
api_type
enum<string>

API Type, internal or external.

Available options:
tcp,
rest,
graphql,
udg,
subgraph,
supergraph,
internal
category
string

Comma separated list of categories you want to filter Apis by.

auth_type
string

Comma separated list of authentication type you want to filter apis by.

tags
string

Comma separated list of gateway segment tags to filter APIs by.

compliance_status
enum<string>

Filter APIs by their governance compliance status.

Available options:
compliant,
non_compliant,
in_process,
not_evaluated
include_stats
boolean

When true, the response includes a top-level stats object with aggregate governance compliance counts over the full filtered set. Omit or set to false for the standard response (backward compatible). Has no effect when governance is disabled.

base_apis
string

For versioned APIs, return only the base versions.If any value is sent in this query parameter only the base version will be returned

q
string

Query string for search/filtering.This will return all apis whose names matches the given pattern

p
integer

Use p query parameter to say which page you want returned. Send number less than 0 to return all items.

sort
enum<string>
  • 'name' - Sort by name in ascending order.
  • '-name' - Sort by name in descending order.
  • 'updated_at' - Sort by updated_at in ascending order.
  • '-updated_at' - Sort by updated_at in descending order.
  • 'created_at' - Sort by created_at in ascending order.
  • '-created_at' - Sort by created_at in descending order.
Available options:
name,
-name,
created_at,
-created_at,
updated_at,
-updated_at

Response

List of API definitions.

apis
object[] | null
pages
integer
stats
object

Aggregate governance compliance counts over the full filtered API set. Present only when include_stats=true and governance is enabled.