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.

Added new guides for Lattice custom actions to create and disable users.

To ensure the stability and reliability of the service, the API will start enforcing rate limits on September 1st 2024. These limits are documented on the respective API endpoint pages in our developer portal.

Learn more on the rate limits page.

An example of a custom integration for Stripe has been added to the Guides section of the community. The example code for this custom integration also has been documented in the Recipes section.

Listing or updating deleted custom Application Fields or fields that have been hidden — will now return an error listing the fields that no longer exist. This will help prevent unexpected behavior when using the API.

The /workflows/actionExecutions endpoint will return additional workflow action executions. In addition to returning a list of user-related workflow action executions in the organization, it will now return a list of all workflow action executions in the organization.

The current GET /users API is limited and does not support pagination. A single API call returns the entire list of users in your organization. For large organizations this could lead to timeouts.

From the 24th of January 2024, the API will support a new torii-version: 1.0.1. This new version supports pagination and sorting using the following new query parameters: sort, size, and cursor. Additionally, the new version will no longer support the minActiveAppsCount parameter.

New tokens created on or after the 23rd of January 2024 will default to the new torii-version: 1.0.1 and will support pagination and sorting.

Tokens created before the 23rd of January 2024 will continue to use the torii-version: 1.0.0 of the API that does not support pagination and returns the full list of users.

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

{  
	"headers": {  
		"torii-version": "1.0.1"  
  }  
}

After the 24th of July 2024, version 1.0.0 of the API will no longer be supported and API calls will use version 1.0.1 by default.
This means that if you make no changes until then, your API calls will return only the first 1000 results. We suggest creating new tokens or using the new header to opt-in to the new version 1.0.1 starting today.

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

The owner field is deprecated and will be removed by the end of 2023. Please use primaryOwner instead.

Added endpoint /apps/{idApp}/users to get an application's users.

SCIM API has been released