The Tasks API provides access to the details of tasks.
Required permissions
To access general task details via the API, ensure the following permissions are set:
| Data type / Method | Permission | Comment |
|---|---|---|
| Read tasks | People's Data > Tasks and flow > People's tasks > View and mark selected people's tasks as complete or incomplete. | Same for read all open tasks and read for an employee. |
| Mark task as complete | People's Data > Tasks and flow > People's tasks > View and mark selected people's tasks as complete or incomplete. |
Rate limiting
Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate-limiting best practices, see Rate limiting.
Below is a table detailing the rate limits for each endpoint in the Onboarding endpoints.
| Method | Endpoint | Limit per minute |
|---|---|---|
| GET | Read all open tasks. | 50 |
| GET | Read tasks of a specific employee | 50 |
| POST | Mark a task as complete | 10 |