Skip to main content

Introduction

The Tyk Developer Portal Management API offers programmatic access to all portal resources that your instance of the portal manages. This API repeats functionality of the user interface and enables APIs consumers integrating their portal instances with their other IT systems such as billings, CRMs, ITSM systems and other software.

Authentication

This API requires an admin authorisation token that is available for admin users of the portal in the profile page.

Pagination

List endpoints in the Tyk Developer Portal Management API return their results in pages. Control pagination with the following query parameters:
ParameterDescriptionDefault
pageThe page number to return. Pages are numbered from 1.1
per_pageThe number of items to return per page.20
limitThe maximum number of records to return for this request. It overrides the row count only, not the page offset, so use per_page for paging rather than limit.Value of per_page
For example, to return the second page of products with 50 products per page:
GET /products?page=2&per_page=50
To page through an entire collection, start at page=1 and increase page until a response returns fewer items than per_page, or an empty list.
The Tyk Developer Portal Management API uses page for the page number. The Tyk Dashboard API uses p for the same purpose, so check the parameter name when you move between the two APIs.
A few endpoints that return fixed collections, such as listing themes, return all results and ignore these parameters.