GetLimitInfo
Retrieves limit information related to the Xero API, helping to monitor how many API calls remain available for the current tenant within the allowed limits.
Procedure-Specific Information
This procedure reports information that the connector caches after each API request. If no requests have been made to a tenant on a connection than this procedure will report 0 rows. Otherwise, the LastModified field reports the last time the information in the row was updated.
If the last modified time is too long ago for your application to use, then this table may be refreshed by executing a query.
The query must read at least one row to ensure that an API request is triggered:
SELECT * FROM Files LIMIT 1
Result Set Columns
| Name | Type | Description |
| TenantId | String | The unique identifier of the tenant that the API rate limit applies to. A row will be returned for each tenant queried during the connection, although typically there is only one tenant. |
| AppRemaining | Integer | The remaining number of API calls available to the current OAuth app for this minute (maximum 10,000). This limit applies across all tenants. |
| MinuteRemaining | Integer | The remaining number of API calls available to the current OAuth app for the current minute (maximum 60). This limit is specific to this tenant. |
| DayRemaining | Integer | The remaining number of API calls available to the current OAuth app for today (maximum 5,000). This limit is specific to this tenant. |
| RetryAfter | Integer | The recommended time to wait before retrying the API call, in the event that one of the above limits was reached. |
| LastModified | Datetime | The timestamp of when the rate limit information was last updated. This data is only refreshed when performing API calls, so it may be older than the current time. |