Sign inGet started
Docs
Get started

Get Usage Summary

Check how many tasks you have used this period and how close you are to your limit.

GET

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Response fields

periodStartstring

First day of the current period.

periodEndstring

Last day of the current period.

usedTasksnumber

Tasks used so far this period.

taskLimitnumber

Your task limit for the period.

softLimitEnabledboolean

True when passing the limit warns instead of blocking.