Rate Limits
The Team Admin API limits how many requests you can send in a minute. This topic explains the limits, how to see how much of your allowance is left, what to do when you exceed it, and how to stay within the limits.
The limits
| Operations | Limit |
|---|---|
| Every operation on a specific team (all operations except List Teams) | 60 requests per UTC minute, per team. |
| List Teams | 60 requests per minute, per APS client ID. |
A UTC minute is a minute on the UTC clock, for example 10:15:00 to 10:15:59 UTC. The allowance starts again at the beginning of each UTC minute.
Team operations
The team operations are List Team Users, Get Team User, Add Team User, List Product Pools, List Assignments, Assign Product, and Unassign Product. They share one allowance for each team. The allowance is shared across all apps, all administrators, and all of these operations. If an administrator runs a script while another app is also working on the same team, both draw on the same allowance.
Different teams have independent allowances. Requests to one team don’t use up the allowance of another.
List Teams
List Teams has its own limit. It counts every List Teams request from your APS client ID, including requests that use the teamId filter. It doesn’t draw on any team’s allowance.
Check your allowance
Responses to team operations include these headers, when rate-limit processing has completed:
| Header | What it tells you |
|---|---|
X-RateLimit-Limit |
The team's allowance per UTC minute. |
X-RateLimit-Remaining |
The number of requests left in the current minute. |
X-RateLimit-Reset |
The time at which the allowance resets, in UTC epoch seconds. |
The headers might not appear on every response. Don’t make your code depend on them being present.
When you exceed a limit
The API returns a 429 status code. The response includes a Retry-After header with the number of seconds to wait. Wait that long before you retry. Don’t retry sooner.
For how to react to 503 and other errors, see Error Handling.
Stay within the limits
Because the allowance is shared, a few habits keep your scripts from reaching it:
- Read long lists in fewer requests: set
limitup to 100 (the default is 50) so that a long list needs fewer pages. See Pagination. - Reuse IDs, not seat counts: when you assign products to many users, list the product pools once and reuse the product IDs. Seat counts change between requests, so don’t rely on an old count.
- Filter instead of reading full lists: use the
emailfilter to find a user and theuserIdfilter to read one user’s assignments. - Watch the headers when they’re present: if the response has
X-RateLimit-Remaining, pause when it reaches0, and resume after the time inX-RateLimit-Reset. - Expect to share: another app or administrator can use some of a team’s allowance.
See also
- Rate limiting and how to request limit increases — General APS overview of rate limits,
429, andRetry-After. Per-API limits (including this API’s allowances) are documented on each product’s Developer Guide and in the REST API Reference. - Error Handling — Learn how to read and react to error responses.
- Pagination — Learn how to read long lists with fewer requests.
- REST API Reference — Look up the headers and responses of each operation.