improved

[Breaking change] List apps API improvements

Overview

We're introducing a breaking change to the GET /apps API to align with the Torii web console:

  1. All App Details seen in the UI will now be supported in the new API
  2. Pagination will be supported for the API

Timeline:

  • January 14th, 2025: new version (1.1) is available for use alongside the default 1.0 version.
  • February 1st, 2025: API Keys created on or after this date will be opted-into version 1.1 by default.
  • (in between): Users of the API will need to opt-in to the new version.
  • July 1st, 2025: new version (1.1) becomes the default and version 1.0 is removed.

We suggest using the new header to opt-in to the new version 1.1 starting today for new developments.

Opt-in to the new API

The API will support a new X-API-Version: 1.1. This new version supports pagination and more App Details. It also introduces a new response body that provides more data on nested objects such as the primaryOwner and other user fields.

To opt-in to the new version, use the following header in your API request:

{  
	"headers": {  
		"X-API-Version": "1.1"  
  }  
}

To learn more about pagination and sorting, please refer to the API reference here: https://developers.toriihq.com/reference/pagination.